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 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/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/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/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/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/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/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/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/AdmissionregistrationApi.md b/src/gen/docs/AdmissionregistrationApi.md similarity index 100% rename from src/gen/AdmissionregistrationApi.md rename to src/gen/docs/AdmissionregistrationApi.md diff --git a/src/gen/AdmissionregistrationV1Api.md b/src/gen/docs/AdmissionregistrationV1Api.md similarity index 100% rename from src/gen/AdmissionregistrationV1Api.md rename to src/gen/docs/AdmissionregistrationV1Api.md diff --git a/src/gen/AdmissionregistrationV1alpha1Api.md b/src/gen/docs/AdmissionregistrationV1alpha1Api.md similarity index 100% rename from src/gen/AdmissionregistrationV1alpha1Api.md rename to src/gen/docs/AdmissionregistrationV1alpha1Api.md diff --git a/src/gen/AdmissionregistrationV1beta1Api.md b/src/gen/docs/AdmissionregistrationV1beta1Api.md similarity index 100% rename from src/gen/AdmissionregistrationV1beta1Api.md rename to src/gen/docs/AdmissionregistrationV1beta1Api.md diff --git a/src/gen/ApiextensionsApi.md b/src/gen/docs/ApiextensionsApi.md similarity index 100% rename from src/gen/ApiextensionsApi.md rename to src/gen/docs/ApiextensionsApi.md diff --git a/src/gen/ApiextensionsV1Api.md b/src/gen/docs/ApiextensionsV1Api.md similarity index 100% rename from src/gen/ApiextensionsV1Api.md rename to src/gen/docs/ApiextensionsV1Api.md diff --git a/src/gen/ApiregistrationApi.md b/src/gen/docs/ApiregistrationApi.md similarity index 100% rename from src/gen/ApiregistrationApi.md rename to src/gen/docs/ApiregistrationApi.md diff --git a/src/gen/ApiregistrationV1Api.md b/src/gen/docs/ApiregistrationV1Api.md similarity index 100% rename from src/gen/ApiregistrationV1Api.md rename to src/gen/docs/ApiregistrationV1Api.md diff --git a/src/gen/ApisApi.md b/src/gen/docs/ApisApi.md similarity index 100% rename from src/gen/ApisApi.md rename to src/gen/docs/ApisApi.md diff --git a/src/gen/AppsApi.md b/src/gen/docs/AppsApi.md similarity index 100% rename from src/gen/AppsApi.md rename to src/gen/docs/AppsApi.md diff --git a/src/gen/AppsV1Api.md b/src/gen/docs/AppsV1Api.md similarity index 100% rename from src/gen/AppsV1Api.md rename to src/gen/docs/AppsV1Api.md diff --git a/src/gen/AuthenticationApi.md b/src/gen/docs/AuthenticationApi.md similarity index 100% rename from src/gen/AuthenticationApi.md rename to src/gen/docs/AuthenticationApi.md diff --git a/src/gen/AuthenticationV1Api.md b/src/gen/docs/AuthenticationV1Api.md similarity index 100% rename from src/gen/AuthenticationV1Api.md rename to src/gen/docs/AuthenticationV1Api.md diff --git a/src/gen/AuthorizationApi.md b/src/gen/docs/AuthorizationApi.md similarity index 100% rename from src/gen/AuthorizationApi.md rename to src/gen/docs/AuthorizationApi.md diff --git a/src/gen/AuthorizationV1Api.md b/src/gen/docs/AuthorizationV1Api.md similarity index 100% rename from src/gen/AuthorizationV1Api.md rename to src/gen/docs/AuthorizationV1Api.md diff --git a/src/gen/AutoscalingApi.md b/src/gen/docs/AutoscalingApi.md similarity index 100% rename from src/gen/AutoscalingApi.md rename to src/gen/docs/AutoscalingApi.md diff --git a/src/gen/AutoscalingV1Api.md b/src/gen/docs/AutoscalingV1Api.md similarity index 100% rename from src/gen/AutoscalingV1Api.md rename to src/gen/docs/AutoscalingV1Api.md diff --git a/src/gen/AutoscalingV2Api.md b/src/gen/docs/AutoscalingV2Api.md similarity index 100% rename from src/gen/AutoscalingV2Api.md rename to src/gen/docs/AutoscalingV2Api.md diff --git a/src/gen/BatchApi.md b/src/gen/docs/BatchApi.md similarity index 100% rename from src/gen/BatchApi.md rename to src/gen/docs/BatchApi.md diff --git a/src/gen/BatchV1Api.md b/src/gen/docs/BatchV1Api.md similarity index 100% rename from src/gen/BatchV1Api.md rename to src/gen/docs/BatchV1Api.md diff --git a/src/gen/CertificatesApi.md b/src/gen/docs/CertificatesApi.md similarity index 100% rename from src/gen/CertificatesApi.md rename to src/gen/docs/CertificatesApi.md diff --git a/src/gen/CertificatesV1Api.md b/src/gen/docs/CertificatesV1Api.md similarity index 100% rename from src/gen/CertificatesV1Api.md rename to src/gen/docs/CertificatesV1Api.md diff --git a/src/gen/CertificatesV1alpha1Api.md b/src/gen/docs/CertificatesV1alpha1Api.md similarity index 100% rename from src/gen/CertificatesV1alpha1Api.md rename to src/gen/docs/CertificatesV1alpha1Api.md diff --git a/src/gen/CertificatesV1beta1Api.md b/src/gen/docs/CertificatesV1beta1Api.md similarity index 100% rename from src/gen/CertificatesV1beta1Api.md rename to src/gen/docs/CertificatesV1beta1Api.md diff --git a/src/gen/CoordinationApi.md b/src/gen/docs/CoordinationApi.md similarity index 100% rename from src/gen/CoordinationApi.md rename to src/gen/docs/CoordinationApi.md diff --git a/src/gen/CoordinationV1Api.md b/src/gen/docs/CoordinationV1Api.md similarity index 100% rename from src/gen/CoordinationV1Api.md rename to src/gen/docs/CoordinationV1Api.md diff --git a/src/gen/CoordinationV1alpha2Api.md b/src/gen/docs/CoordinationV1alpha2Api.md similarity index 100% rename from src/gen/CoordinationV1alpha2Api.md rename to src/gen/docs/CoordinationV1alpha2Api.md diff --git a/src/gen/CoordinationV1beta1Api.md b/src/gen/docs/CoordinationV1beta1Api.md similarity index 100% rename from src/gen/CoordinationV1beta1Api.md rename to src/gen/docs/CoordinationV1beta1Api.md diff --git a/src/gen/CoreApi.md b/src/gen/docs/CoreApi.md similarity index 100% rename from src/gen/CoreApi.md rename to src/gen/docs/CoreApi.md diff --git a/src/gen/CoreV1Api.md b/src/gen/docs/CoreV1Api.md similarity index 100% rename from src/gen/CoreV1Api.md rename to src/gen/docs/CoreV1Api.md diff --git a/src/gen/CustomObjectsApi.md b/src/gen/docs/CustomObjectsApi.md similarity index 100% rename from src/gen/CustomObjectsApi.md rename to src/gen/docs/CustomObjectsApi.md diff --git a/src/gen/DiscoveryApi.md b/src/gen/docs/DiscoveryApi.md similarity index 100% rename from src/gen/DiscoveryApi.md rename to src/gen/docs/DiscoveryApi.md diff --git a/src/gen/DiscoveryV1Api.md b/src/gen/docs/DiscoveryV1Api.md similarity index 100% rename from src/gen/DiscoveryV1Api.md rename to src/gen/docs/DiscoveryV1Api.md diff --git a/src/gen/EventsApi.md b/src/gen/docs/EventsApi.md similarity index 100% rename from src/gen/EventsApi.md rename to src/gen/docs/EventsApi.md diff --git a/src/gen/EventsV1Api.md b/src/gen/docs/EventsV1Api.md similarity index 100% rename from src/gen/EventsV1Api.md rename to src/gen/docs/EventsV1Api.md diff --git a/src/gen/FlowcontrolApiserverApi.md b/src/gen/docs/FlowcontrolApiserverApi.md similarity index 100% rename from src/gen/FlowcontrolApiserverApi.md rename to src/gen/docs/FlowcontrolApiserverApi.md diff --git a/src/gen/FlowcontrolApiserverV1Api.md b/src/gen/docs/FlowcontrolApiserverV1Api.md similarity index 100% rename from src/gen/FlowcontrolApiserverV1Api.md rename to src/gen/docs/FlowcontrolApiserverV1Api.md diff --git a/src/gen/InternalApiserverApi.md b/src/gen/docs/InternalApiserverApi.md similarity index 100% rename from src/gen/InternalApiserverApi.md rename to src/gen/docs/InternalApiserverApi.md diff --git a/src/gen/InternalApiserverV1alpha1Api.md b/src/gen/docs/InternalApiserverV1alpha1Api.md similarity index 100% rename from src/gen/InternalApiserverV1alpha1Api.md rename to src/gen/docs/InternalApiserverV1alpha1Api.md diff --git a/src/gen/LogsApi.md b/src/gen/docs/LogsApi.md similarity index 100% rename from src/gen/LogsApi.md rename to src/gen/docs/LogsApi.md diff --git a/src/gen/NetworkingApi.md b/src/gen/docs/NetworkingApi.md similarity index 100% rename from src/gen/NetworkingApi.md rename to src/gen/docs/NetworkingApi.md diff --git a/src/gen/NetworkingV1Api.md b/src/gen/docs/NetworkingV1Api.md similarity index 100% rename from src/gen/NetworkingV1Api.md rename to src/gen/docs/NetworkingV1Api.md diff --git a/src/gen/NetworkingV1beta1Api.md b/src/gen/docs/NetworkingV1beta1Api.md similarity index 100% rename from src/gen/NetworkingV1beta1Api.md rename to src/gen/docs/NetworkingV1beta1Api.md diff --git a/src/gen/NodeApi.md b/src/gen/docs/NodeApi.md similarity index 100% rename from src/gen/NodeApi.md rename to src/gen/docs/NodeApi.md diff --git a/src/gen/NodeV1Api.md b/src/gen/docs/NodeV1Api.md similarity index 100% rename from src/gen/NodeV1Api.md rename to src/gen/docs/NodeV1Api.md diff --git a/src/gen/OpenidApi.md b/src/gen/docs/OpenidApi.md similarity index 100% rename from src/gen/OpenidApi.md rename to src/gen/docs/OpenidApi.md diff --git a/src/gen/PolicyApi.md b/src/gen/docs/PolicyApi.md similarity index 100% rename from src/gen/PolicyApi.md rename to src/gen/docs/PolicyApi.md diff --git a/src/gen/PolicyV1Api.md b/src/gen/docs/PolicyV1Api.md similarity index 100% rename from src/gen/PolicyV1Api.md rename to src/gen/docs/PolicyV1Api.md diff --git a/src/gen/RbacAuthorizationApi.md b/src/gen/docs/RbacAuthorizationApi.md similarity index 100% rename from src/gen/RbacAuthorizationApi.md rename to src/gen/docs/RbacAuthorizationApi.md diff --git a/src/gen/RbacAuthorizationV1Api.md b/src/gen/docs/RbacAuthorizationV1Api.md similarity index 100% rename from src/gen/RbacAuthorizationV1Api.md rename to src/gen/docs/RbacAuthorizationV1Api.md diff --git a/src/gen/ResourceApi.md b/src/gen/docs/ResourceApi.md similarity index 100% rename from src/gen/ResourceApi.md rename to src/gen/docs/ResourceApi.md diff --git a/src/gen/ResourceV1Api.md b/src/gen/docs/ResourceV1Api.md similarity index 100% rename from src/gen/ResourceV1Api.md rename to src/gen/docs/ResourceV1Api.md diff --git a/src/gen/ResourceV1alpha3Api.md b/src/gen/docs/ResourceV1alpha3Api.md similarity index 100% rename from src/gen/ResourceV1alpha3Api.md rename to src/gen/docs/ResourceV1alpha3Api.md diff --git a/src/gen/ResourceV1beta1Api.md b/src/gen/docs/ResourceV1beta1Api.md similarity index 100% rename from src/gen/ResourceV1beta1Api.md rename to src/gen/docs/ResourceV1beta1Api.md diff --git a/src/gen/ResourceV1beta2Api.md b/src/gen/docs/ResourceV1beta2Api.md similarity index 100% rename from src/gen/ResourceV1beta2Api.md rename to src/gen/docs/ResourceV1beta2Api.md diff --git a/src/gen/SchedulingApi.md b/src/gen/docs/SchedulingApi.md similarity index 100% rename from src/gen/SchedulingApi.md rename to src/gen/docs/SchedulingApi.md diff --git a/src/gen/SchedulingV1Api.md b/src/gen/docs/SchedulingV1Api.md similarity index 100% rename from src/gen/SchedulingV1Api.md rename to src/gen/docs/SchedulingV1Api.md diff --git a/src/gen/SchedulingV1alpha1Api.md b/src/gen/docs/SchedulingV1alpha1Api.md similarity index 100% rename from src/gen/SchedulingV1alpha1Api.md rename to src/gen/docs/SchedulingV1alpha1Api.md diff --git a/src/gen/StorageApi.md b/src/gen/docs/StorageApi.md similarity index 100% rename from src/gen/StorageApi.md rename to src/gen/docs/StorageApi.md diff --git a/src/gen/StorageV1Api.md b/src/gen/docs/StorageV1Api.md similarity index 100% rename from src/gen/StorageV1Api.md rename to src/gen/docs/StorageV1Api.md diff --git a/src/gen/StorageV1beta1Api.md b/src/gen/docs/StorageV1beta1Api.md similarity index 100% rename from src/gen/StorageV1beta1Api.md rename to src/gen/docs/StorageV1beta1Api.md diff --git a/src/gen/StoragemigrationApi.md b/src/gen/docs/StoragemigrationApi.md similarity index 100% rename from src/gen/StoragemigrationApi.md rename to src/gen/docs/StoragemigrationApi.md diff --git a/src/gen/StoragemigrationV1beta1Api.md b/src/gen/docs/StoragemigrationV1beta1Api.md similarity index 100% rename from src/gen/StoragemigrationV1beta1Api.md rename to src/gen/docs/StoragemigrationV1beta1Api.md diff --git a/src/gen/VersionApi.md b/src/gen/docs/VersionApi.md similarity index 100% rename from src/gen/VersionApi.md rename to src/gen/docs/VersionApi.md diff --git a/src/gen/WellKnownApi.md b/src/gen/docs/WellKnownApi.md similarity index 100% rename from src/gen/WellKnownApi.md rename to src/gen/docs/WellKnownApi.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!)