ResourceV1Api

All URIs are relative to http://localhost

Device Class

Method	HTTP request	Description
createDeviceClass	POST /apis/resource.k8s.io/v1/deviceclasses	create a DeviceClass
readDeviceClass	GET /apis/resource.k8s.io/v1/deviceclasses/{name}	Generated API methods accept optional request options as a second argument.
listDeviceClass	GET /apis/resource.k8s.io/v1/deviceclasses	Generated API methods accept optional request options as a second argument.
patchDeviceClass	PATCH /apis/resource.k8s.io/v1/deviceclasses/{name}	partially update the specified DeviceClass
replaceDeviceClass	PUT /apis/resource.k8s.io/v1/deviceclasses/{name}	replace the specified DeviceClass
deleteCollectionDeviceClass	DELETE /apis/resource.k8s.io/v1/deviceclasses	Generated API methods accept optional request options as a second argument.
deleteDeviceClass	DELETE /apis/resource.k8s.io/v1/deviceclasses/{name}	Generated API methods accept optional request options as a second argument.

Resource Claim

Method	HTTP request	Description
createNamespacedResourceClaim	POST /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims	create a ResourceClaim
readNamespacedResourceClaim	GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}	Generated API methods accept optional request options as a second argument.
listNamespacedResourceClaim	GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims	Generated API methods accept optional request options as a second argument.
readNamespacedResourceClaimStatus	GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status	Generated API methods accept optional request options as a second argument.
listResourceClaimForAllNamespaces	GET /apis/resource.k8s.io/v1/resourceclaims	Generated API methods accept optional request options as a second argument.
patchNamespacedResourceClaim	PATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}	partially update the specified ResourceClaim
patchNamespacedResourceClaimStatus	PATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status	partially update status of the specified ResourceClaim
replaceNamespacedResourceClaim	PUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}	replace the specified ResourceClaim
deleteCollectionNamespacedResourceClaim	DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims	Generated API methods accept optional request options as a second argument.
deleteNamespacedResourceClaim	DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}	Generated API methods accept optional request options as a second argument.
replaceNamespacedResourceClaimStatus	PUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaims/{name}/status	replace status of the specified ResourceClaim

Resource Claim Template

Method	HTTP request	Description
createNamespacedResourceClaimTemplate	POST /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates	create a ResourceClaimTemplate
readNamespacedResourceClaimTemplate	GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}	Generated API methods accept optional request options as a second argument.
listNamespacedResourceClaimTemplate	GET /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates	Generated API methods accept optional request options as a second argument.
listResourceClaimTemplateForAllNamespaces	GET /apis/resource.k8s.io/v1/resourceclaimtemplates	Generated API methods accept optional request options as a second argument.
patchNamespacedResourceClaimTemplate	PATCH /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}	partially update the specified ResourceClaimTemplate
replaceNamespacedResourceClaimTemplate	PUT /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}	replace the specified ResourceClaimTemplate
deleteCollectionNamespacedResourceClaimTemplate	DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates	Generated API methods accept optional request options as a second argument.
deleteNamespacedResourceClaimTemplate	DELETE /apis/resource.k8s.io/v1/namespaces/{namespace}/resourceclaimtemplates/{name}	Generated API methods accept optional request options as a second argument.

Resource Slice

Method	HTTP request	Description
createResourceSlice	POST /apis/resource.k8s.io/v1/resourceslices	create a ResourceSlice
readResourceSlice	GET /apis/resource.k8s.io/v1/resourceslices/{name}	Generated API methods accept optional request options as a second argument.
listResourceSlice	GET /apis/resource.k8s.io/v1/resourceslices	Generated API methods accept optional request options as a second argument.
patchResourceSlice	PATCH /apis/resource.k8s.io/v1/resourceslices/{name}	partially update the specified ResourceSlice
replaceResourceSlice	PUT /apis/resource.k8s.io/v1/resourceslices/{name}	replace the specified ResourceSlice
deleteCollectionResourceSlice	DELETE /apis/resource.k8s.io/v1/resourceslices	Generated API methods accept optional request options as a second argument.
deleteResourceSlice	DELETE /apis/resource.k8s.io/v1/resourceslices/{name}	Generated API methods accept optional request options as a second argument.

APIResources

Method	HTTP request	Description
getAPIResources	GET /apis/resource.k8s.io/v1/	Generated API methods accept optional request options as a second argument.

Device Class

createDeviceClass

V1DeviceClass createDeviceClass(body)

create a DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiCreateDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiCreateDeviceClassRequest = {
  body: { /* See V1DeviceClass: /models/other#v1deviceclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1DeviceClass
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1DeviceClass

readDeviceClass

V1DeviceClass readDeviceClass()

Generated API methods accept optional request options as a second argument.

read the specified DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReadDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReadDeviceClassRequest = {
    // name of the DeviceClass
  name: "name_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
};

const data = await apiInstance.readDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
name	[string]	name of the DeviceClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1DeviceClass

listDeviceClass

V1DeviceClassList listDeviceClass()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListDeviceClassRequest = {
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
  // ...9 more optional parameter(s)
};

const data = await apiInstance.listDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1DeviceClassList

patchDeviceClass

V1DeviceClass patchDeviceClass(body)

partially update the specified DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiPatchDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiPatchDeviceClassRequest = {
    // name of the DeviceClass
  name: "name_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
  fieldManager: "fieldManager_example",
  // ...2 more optional parameter(s)
};

const data = await apiInstance.patchDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the DeviceClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
force	[boolean]	Force is going to "force" Apply requests. More info	(optional) defaults to undefined

Return type

V1DeviceClass

replaceDeviceClass

V1DeviceClass replaceDeviceClass(body)

replace the specified DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReplaceDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReplaceDeviceClassRequest = {
    // name of the DeviceClass
  name: "name_example",
  body: { /* See V1DeviceClass: /models/other#v1deviceclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.replaceDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1DeviceClass
name	[string]	name of the DeviceClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1DeviceClass

deleteCollectionDeviceClass

V1Status deleteCollectionDeviceClass()

Generated API methods accept optional request options as a second argument.

delete collection of DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteCollectionDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteCollectionDeviceClassRequest = {
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined

Return type

V1Status

deleteDeviceClass

V1DeviceClass deleteDeviceClass()

Generated API methods accept optional request options as a second argument.

delete a DeviceClass

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteDeviceClassRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteDeviceClassRequest = {
    // name of the DeviceClass
  name: "name_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
  gracePeriodSeconds: 1,
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...3 more optional parameter(s)
};

const data = await apiInstance.deleteDeviceClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the DeviceClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined

Return type

V1DeviceClass

Resource Claim

createNamespacedResourceClaim

ResourceV1ResourceClaim createNamespacedResourceClaim(body)

create a ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiCreateNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiCreateNamespacedResourceClaimRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createNamespacedResourceClaim(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	ResourceV1ResourceClaim
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

readNamespacedResourceClaim

ResourceV1ResourceClaim readNamespacedResourceClaim()

Generated API methods accept optional request options as a second argument.

read the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReadNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReadNamespacedResourceClaimRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
};

const data = await apiInstance.readNamespacedResourceClaim(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
name	[string]	name of the ResourceClaim	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

listNamespacedResourceClaim

V1ResourceClaimList listNamespacedResourceClaim()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListNamespacedResourceClaimRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
  // ...9 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1ResourceClaimList

readNamespacedResourceClaimStatus

ResourceV1ResourceClaim readNamespacedResourceClaimStatus()

Generated API methods accept optional request options as a second argument.

read status of the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReadNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReadNamespacedResourceClaimStatusRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
};

const data = await apiInstance.readNamespacedResourceClaimStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
name	[string]	name of the ResourceClaim	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

listResourceClaimForAllNamespaces

V1ResourceClaimList listResourceClaimForAllNamespaces()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListResourceClaimForAllNamespacesRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListResourceClaimForAllNamespacesRequest = {
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
  fieldSelector: "fieldSelector_example",
  // ...9 more optional parameter(s)
};

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". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1ResourceClaimList

patchNamespacedResourceClaim

ResourceV1ResourceClaim patchNamespacedResourceClaim(body)

partially update the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiPatchNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiPatchNamespacedResourceClaimRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
  fieldManager: "fieldManager_example",
  // ...2 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
force	[boolean]	Force is going to "force" Apply requests. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

patchNamespacedResourceClaimStatus

ResourceV1ResourceClaim patchNamespacedResourceClaimStatus(body)

partially update status of the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiPatchNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiPatchNamespacedResourceClaimStatusRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
  fieldManager: "fieldManager_example",
  // ...2 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
force	[boolean]	Force is going to "force" Apply requests. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

replaceNamespacedResourceClaim

ResourceV1ResourceClaim replaceNamespacedResourceClaim(body)

replace the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReplaceNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReplaceNamespacedResourceClaimRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.replaceNamespacedResourceClaim(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	ResourceV1ResourceClaim
name	[string]	name of the ResourceClaim	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

deleteCollectionNamespacedResourceClaim

V1Status deleteCollectionNamespacedResourceClaim()

Generated API methods accept optional request options as a second argument.

delete collection of ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...12 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined

Return type

V1Status

deleteNamespacedResourceClaim

ResourceV1ResourceClaim deleteNamespacedResourceClaim()

Generated API methods accept optional request options as a second argument.

delete a ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteNamespacedResourceClaimRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteNamespacedResourceClaimRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
  gracePeriodSeconds: 1,
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...3 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

replaceNamespacedResourceClaimStatus

ResourceV1ResourceClaim replaceNamespacedResourceClaimStatus(body)

replace status of the specified ResourceClaim

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReplaceNamespacedResourceClaimStatusRequest = {
    // name of the ResourceClaim
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.replaceNamespacedResourceClaimStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	ResourceV1ResourceClaim
name	[string]	name of the ResourceClaim	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

ResourceV1ResourceClaim

Resource Claim Template

createNamespacedResourceClaimTemplate

V1ResourceClaimTemplate createNamespacedResourceClaimTemplate(body)

create a ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiCreateNamespacedResourceClaimTemplateRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See V1ResourceClaimTemplate: /models/other#v1resourceclaimtemplate */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createNamespacedResourceClaimTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1ResourceClaimTemplate
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplate

readNamespacedResourceClaimTemplate

V1ResourceClaimTemplate readNamespacedResourceClaimTemplate()

Generated API methods accept optional request options as a second argument.

read the specified ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReadNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReadNamespacedResourceClaimTemplateRequest = {
    // name of the ResourceClaimTemplate
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
};

const data = await apiInstance.readNamespacedResourceClaimTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
name	[string]	name of the ResourceClaimTemplate	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplate

listNamespacedResourceClaimTemplate

V1ResourceClaimTemplateList listNamespacedResourceClaimTemplate()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListNamespacedResourceClaimTemplateRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
  // ...9 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplateList

listResourceClaimTemplateForAllNamespaces

V1ResourceClaimTemplateList listResourceClaimTemplateForAllNamespaces()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListResourceClaimTemplateForAllNamespacesRequest = {
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
  fieldSelector: "fieldSelector_example",
  // ...9 more optional parameter(s)
};

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". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplateList

patchNamespacedResourceClaimTemplate

V1ResourceClaimTemplate patchNamespacedResourceClaimTemplate(body)

partially update the specified ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiPatchNamespacedResourceClaimTemplateRequest = {
    // name of the ResourceClaimTemplate
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
  fieldManager: "fieldManager_example",
  // ...2 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
force	[boolean]	Force is going to "force" Apply requests. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplate

replaceNamespacedResourceClaimTemplate

V1ResourceClaimTemplate replaceNamespacedResourceClaimTemplate(body)

replace the specified ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReplaceNamespacedResourceClaimTemplateRequest = {
    // name of the ResourceClaimTemplate
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See V1ResourceClaimTemplate: /models/other#v1resourceclaimtemplate */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.replaceNamespacedResourceClaimTemplate(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1ResourceClaimTemplate
name	[string]	name of the ResourceClaimTemplate	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplate

deleteCollectionNamespacedResourceClaimTemplate

V1Status deleteCollectionNamespacedResourceClaimTemplate()

Generated API methods accept optional request options as a second argument.

delete collection of ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteCollectionNamespacedResourceClaimTemplateRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...12 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined

Return type

V1Status

deleteNamespacedResourceClaimTemplate

V1ResourceClaimTemplate deleteNamespacedResourceClaimTemplate()

Generated API methods accept optional request options as a second argument.

delete a ResourceClaimTemplate

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteNamespacedResourceClaimTemplateRequest = {
    // name of the ResourceClaimTemplate
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
  gracePeriodSeconds: 1,
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...3 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined

Return type

V1ResourceClaimTemplate

Resource Slice

createResourceSlice

V1ResourceSlice createResourceSlice(body)

create a ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiCreateResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiCreateResourceSliceRequest = {
  body: { /* See V1ResourceSlice: /models/other#v1resourceslice */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.createResourceSlice(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1ResourceSlice
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1ResourceSlice

readResourceSlice

V1ResourceSlice readResourceSlice()

Generated API methods accept optional request options as a second argument.

read the specified ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReadResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReadResourceSliceRequest = {
    // name of the ResourceSlice
  name: "name_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
};

const data = await apiInstance.readResourceSlice(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
name	[string]	name of the ResourceSlice	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1ResourceSlice

listResourceSlice

V1ResourceSliceList listResourceSlice()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiListResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiListResourceSliceRequest = {
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
  allowWatchBookmarks: true,
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
  // ...9 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined
watch	[boolean]	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info	(optional) defaults to undefined

Return type

V1ResourceSliceList

patchResourceSlice

V1ResourceSlice patchResourceSlice(body)

partially update the specified ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiPatchResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiPatchResourceSliceRequest = {
    // name of the ResourceSlice
  name: "name_example",
  body: { /* See type definition in parameter table */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
  fieldManager: "fieldManager_example",
  // ...2 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined
force	[boolean]	Force is going to "force" Apply requests. More info	(optional) defaults to undefined

Return type

V1ResourceSlice

replaceResourceSlice

V1ResourceSlice replaceResourceSlice(body)

replace the specified ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiReplaceResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiReplaceResourceSliceRequest = {
    // name of the ResourceSlice
  name: "name_example",
  body: { /* See V1ResourceSlice: /models/other#v1resourceslice */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
  fieldManager: "fieldManager_example",
  // ...1 more optional parameter(s)
};

const data = await apiInstance.replaceResourceSlice(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1ResourceSlice
name	[string]	name of the ResourceSlice	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldManager	[string]	fieldManager is a name associated with the actor or entity that is making these changes. More info	(optional) defaults to undefined
fieldValidation	[string]	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info	(optional) defaults to undefined

Return type

V1ResourceSlice

deleteCollectionResourceSlice

V1Status deleteCollectionResourceSlice()

Generated API methods accept optional request options as a second argument.

delete collection of ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteCollectionResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteCollectionResourceSliceRequest = {
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
  _continue: "continue_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...12 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	sendInitialEvents=true may be set together with watch=true. More info	(optional) defaults to undefined
shardSelector	[string]	shardSelector restricts the list of returned objects using a CEL-based shard selector expression.	(optional) defaults to undefined
timeoutSeconds	[number]	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info	(optional) defaults to undefined

Return type

V1Status

deleteResourceSlice

V1ResourceSlice deleteResourceSlice()

Generated API methods accept optional request options as a second argument.

delete a ResourceSlice

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';
import type { ResourceV1ApiDeleteResourceSliceRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request: ResourceV1ApiDeleteResourceSliceRequest = {
    // name of the ResourceSlice
  name: "name_example",
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
  gracePeriodSeconds: 1,
  body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
  // ...3 more optional parameter(s)
};

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. More info	(optional) defaults to undefined
dryRun	[string]	When present, indicates that modifications should not be persisted. More info	(optional) defaults to undefined
gracePeriodSeconds	[number]	The duration in seconds before the object should be deleted. More info	(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential	[boolean]	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info	(optional) defaults to undefined
orphanDependents	[boolean]	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info	(optional) defaults to undefined
propagationPolicy	[string]	Whether and how garbage collection will be performed. More info	(optional) defaults to undefined

Return type

V1ResourceSlice

APIResources

getAPIResources

V1APIResourceList getAPIResources()

Generated API methods accept optional request options as a second argument.

get available resources

Example

import { createConfiguration, ResourceV1Api } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new ResourceV1Api(configuration);

const request = {};

const data = await apiInstance.getAPIResources(request);
console.log('API called successfully. Returned data:', data);

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList