StorageV1Api

All URIs are relative to http://localhost

CSIDriver

Method	HTTP request	Description
createCSIDriver	POST /apis/storage.k8s.io/v1/csidrivers	create a CSIDriver
readCSIDriver	GET /apis/storage.k8s.io/v1/csidrivers/{name}	Generated API methods accept optional request options as a second argument.
listCSIDriver	GET /apis/storage.k8s.io/v1/csidrivers	Generated API methods accept optional request options as a second argument.
patchCSIDriver	PATCH /apis/storage.k8s.io/v1/csidrivers/{name}	partially update the specified CSIDriver
replaceCSIDriver	PUT /apis/storage.k8s.io/v1/csidrivers/{name}	replace the specified CSIDriver
deleteCSIDriver	DELETE /apis/storage.k8s.io/v1/csidrivers/{name}	Generated API methods accept optional request options as a second argument.
deleteCollectionCSIDriver	DELETE /apis/storage.k8s.io/v1/csidrivers	Generated API methods accept optional request options as a second argument.

CSINode

Method	HTTP request	Description
createCSINode	POST /apis/storage.k8s.io/v1/csinodes	create a CSINode
readCSINode	GET /apis/storage.k8s.io/v1/csinodes/{name}	Generated API methods accept optional request options as a second argument.
listCSINode	GET /apis/storage.k8s.io/v1/csinodes	Generated API methods accept optional request options as a second argument.
patchCSINode	PATCH /apis/storage.k8s.io/v1/csinodes/{name}	partially update the specified CSINode
replaceCSINode	PUT /apis/storage.k8s.io/v1/csinodes/{name}	replace the specified CSINode
deleteCSINode	DELETE /apis/storage.k8s.io/v1/csinodes/{name}	Generated API methods accept optional request options as a second argument.
deleteCollectionCSINode	DELETE /apis/storage.k8s.io/v1/csinodes	Generated API methods accept optional request options as a second argument.

CSIStorage Capacity

Method	HTTP request	Description
createNamespacedCSIStorageCapacity	POST /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities	create a CSIStorageCapacity
readNamespacedCSIStorageCapacity	GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}	Generated API methods accept optional request options as a second argument.
listNamespacedCSIStorageCapacity	GET /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities	Generated API methods accept optional request options as a second argument.
listCSIStorageCapacityForAllNamespaces	GET /apis/storage.k8s.io/v1/csistoragecapacities	Generated API methods accept optional request options as a second argument.
patchNamespacedCSIStorageCapacity	PATCH /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}	partially update the specified CSIStorageCapacity
replaceNamespacedCSIStorageCapacity	PUT /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}	replace the specified CSIStorageCapacity
deleteCollectionNamespacedCSIStorageCapacity	DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities	Generated API methods accept optional request options as a second argument.
deleteNamespacedCSIStorageCapacity	DELETE /apis/storage.k8s.io/v1/namespaces/{namespace}/csistoragecapacities/{name}	Generated API methods accept optional request options as a second argument.

Storage Class

Method	HTTP request	Description
createStorageClass	POST /apis/storage.k8s.io/v1/storageclasses	create a StorageClass
readStorageClass	GET /apis/storage.k8s.io/v1/storageclasses/{name}	Generated API methods accept optional request options as a second argument.
listStorageClass	GET /apis/storage.k8s.io/v1/storageclasses	Generated API methods accept optional request options as a second argument.
patchStorageClass	PATCH /apis/storage.k8s.io/v1/storageclasses/{name}	partially update the specified StorageClass
replaceStorageClass	PUT /apis/storage.k8s.io/v1/storageclasses/{name}	replace the specified StorageClass
deleteCollectionStorageClass	DELETE /apis/storage.k8s.io/v1/storageclasses	Generated API methods accept optional request options as a second argument.
deleteStorageClass	DELETE /apis/storage.k8s.io/v1/storageclasses/{name}	Generated API methods accept optional request options as a second argument.

Volume Attachment

Method	HTTP request	Description
createVolumeAttachment	POST /apis/storage.k8s.io/v1/volumeattachments	create a VolumeAttachment
readVolumeAttachment	GET /apis/storage.k8s.io/v1/volumeattachments/{name}	Generated API methods accept optional request options as a second argument.
readVolumeAttachmentStatus	GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status	Generated API methods accept optional request options as a second argument.
listVolumeAttachment	GET /apis/storage.k8s.io/v1/volumeattachments	Generated API methods accept optional request options as a second argument.
patchVolumeAttachment	PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}	partially update the specified VolumeAttachment
patchVolumeAttachmentStatus	PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status	partially update status of the specified VolumeAttachment
replaceVolumeAttachment	PUT /apis/storage.k8s.io/v1/volumeattachments/{name}	replace the specified VolumeAttachment
replaceVolumeAttachmentStatus	PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status	replace status of the specified VolumeAttachment
deleteCollectionVolumeAttachment	DELETE /apis/storage.k8s.io/v1/volumeattachments	Generated API methods accept optional request options as a second argument.
deleteVolumeAttachment	DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}	Generated API methods accept optional request options as a second argument.

Volume Attributes Class

Method	HTTP request	Description
createVolumeAttributesClass	POST /apis/storage.k8s.io/v1/volumeattributesclasses	create a VolumeAttributesClass
readVolumeAttributesClass	GET /apis/storage.k8s.io/v1/volumeattributesclasses/{name}	Generated API methods accept optional request options as a second argument.
listVolumeAttributesClass	GET /apis/storage.k8s.io/v1/volumeattributesclasses	Generated API methods accept optional request options as a second argument.
patchVolumeAttributesClass	PATCH /apis/storage.k8s.io/v1/volumeattributesclasses/{name}	partially update the specified VolumeAttributesClass
replaceVolumeAttributesClass	PUT /apis/storage.k8s.io/v1/volumeattributesclasses/{name}	replace the specified VolumeAttributesClass
deleteCollectionVolumeAttributesClass	DELETE /apis/storage.k8s.io/v1/volumeattributesclasses	Generated API methods accept optional request options as a second argument.
deleteVolumeAttributesClass	DELETE /apis/storage.k8s.io/v1/volumeattributesclasses/{name}	Generated API methods accept optional request options as a second argument.

APIResources

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

CSIDriver

createCSIDriver

V1CSIDriver createCSIDriver(body)

create a CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateCSIDriverRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateCSIDriverRequest = {
  body: { /* See V1CSIDriver: /models/configuration-storage#v1csidriver */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createCSIDriver(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSIDriver
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIDriver

readCSIDriver

V1CSIDriver readCSIDriver()

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

read the specified CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadCSIDriverRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1CSIDriver

listCSIDriver

V1CSIDriverList listCSIDriver()

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

list or watch objects of kind CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListCSIDriverRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIDriverList

patchCSIDriver

V1CSIDriver patchCSIDriver(body)

partially update the specified CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchCSIDriverRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchCSIDriverRequest = {
    // name of the CSIDriver
  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.patchCSIDriver(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the CSIDriver	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIDriver

replaceCSIDriver

V1CSIDriver replaceCSIDriver(body)

replace the specified CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceCSIDriverRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceCSIDriverRequest = {
    // name of the CSIDriver
  name: "name_example",
  body: { /* See V1CSIDriver: /models/configuration-storage#v1csidriver */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceCSIDriver(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSIDriver
name	[string]	name of the CSIDriver	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIDriver

deleteCSIDriver

V1CSIDriver deleteCSIDriver()

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

delete a CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCSIDriverRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the CSIDriver	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIDriver

deleteCollectionCSIDriver

V1Status deleteCollectionCSIDriver()

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

delete collection of CSIDriver

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionCSIDriverRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. 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

CSINode

createCSINode

V1CSINode createCSINode(body)

create a CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateCSINodeRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateCSINodeRequest = {
  body: { /* See V1CSINode: /models/configuration-storage#v1csinode */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createCSINode(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSINode
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSINode

readCSINode

V1CSINode readCSINode()

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

read the specified CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadCSINodeRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1CSINode

listCSINode

V1CSINodeList listCSINode()

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

list or watch objects of kind CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListCSINodeRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSINodeList

patchCSINode

V1CSINode patchCSINode(body)

partially update the specified CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchCSINodeRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchCSINodeRequest = {
    // name of the CSINode
  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.patchCSINode(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the CSINode	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSINode

replaceCSINode

V1CSINode replaceCSINode(body)

replace the specified CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceCSINodeRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceCSINodeRequest = {
    // name of the CSINode
  name: "name_example",
  body: { /* See V1CSINode: /models/configuration-storage#v1csinode */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceCSINode(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSINode
name	[string]	name of the CSINode	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSINode

deleteCSINode

V1CSINode deleteCSINode()

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

delete a CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCSINodeRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the CSINode	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSINode

deleteCollectionCSINode

V1Status deleteCollectionCSINode()

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

delete collection of CSINode

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionCSINodeRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. 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

CSIStorage Capacity

createNamespacedCSIStorageCapacity

V1CSIStorageCapacity createNamespacedCSIStorageCapacity(body)

create a CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateNamespacedCSIStorageCapacityRequest = {
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See V1CSIStorageCapacity: /models/configuration-storage#v1csistoragecapacity */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createNamespacedCSIStorageCapacity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSIStorageCapacity
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIStorageCapacity

readNamespacedCSIStorageCapacity

V1CSIStorageCapacity readNamespacedCSIStorageCapacity()

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

read the specified CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1CSIStorageCapacity

listNamespacedCSIStorageCapacity

V1CSIStorageCapacityList listNamespacedCSIStorageCapacity()

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

list or watch objects of kind CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIStorageCapacityList

listCSIStorageCapacityForAllNamespaces

V1CSIStorageCapacityList listCSIStorageCapacityForAllNamespaces()

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

list or watch objects of kind CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListCSIStorageCapacityForAllNamespacesRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". 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

V1CSIStorageCapacityList

patchNamespacedCSIStorageCapacity

V1CSIStorageCapacity patchNamespacedCSIStorageCapacity(body)

partially update the specified CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchNamespacedCSIStorageCapacityRequest = {
    // name of the CSIStorageCapacity
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* 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.patchNamespacedCSIStorageCapacity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the CSIStorageCapacity	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIStorageCapacity

replaceNamespacedCSIStorageCapacity

V1CSIStorageCapacity replaceNamespacedCSIStorageCapacity(body)

replace the specified CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceNamespacedCSIStorageCapacityRequest = {
    // name of the CSIStorageCapacity
  name: "name_example",
    // object name and auth scope, such as for teams and projects
  namespace: "namespace_example",
  body: { /* See V1CSIStorageCapacity: /models/configuration-storage#v1csistoragecapacity */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceNamespacedCSIStorageCapacity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1CSIStorageCapacity
name	[string]	name of the CSIStorageCapacity	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1CSIStorageCapacity

deleteCollectionNamespacedCSIStorageCapacity

V1Status deleteCollectionNamespacedCSIStorageCapacity()

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

delete collection of CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

deleteNamespacedCSIStorageCapacity

V1Status deleteNamespacedCSIStorageCapacity()

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

delete a CSIStorageCapacity

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteNamespacedCSIStorageCapacityRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the CSIStorageCapacity	defaults to undefined
namespace	[string]	object name and auth scope, such as for teams and projects	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1Status

Storage Class

createStorageClass

V1StorageClass createStorageClass(body)

create a StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateStorageClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateStorageClassRequest = {
  body: { /* See V1StorageClass: /models/configuration-storage#v1storageclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createStorageClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1StorageClass
pretty	[string]	If 'true', then the output is pretty printed. 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

V1StorageClass

readStorageClass

V1StorageClass readStorageClass()

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

read the specified StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadStorageClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1StorageClass

listStorageClass

V1StorageClassList listStorageClass()

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

list or watch objects of kind StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListStorageClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. 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

V1StorageClassList

patchStorageClass

V1StorageClass patchStorageClass(body)

partially update the specified StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchStorageClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchStorageClassRequest = {
    // name of the StorageClass
  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.patchStorageClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the StorageClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1StorageClass

replaceStorageClass

V1StorageClass replaceStorageClass(body)

replace the specified StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceStorageClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceStorageClassRequest = {
    // name of the StorageClass
  name: "name_example",
  body: { /* See V1StorageClass: /models/configuration-storage#v1storageclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceStorageClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1StorageClass
name	[string]	name of the StorageClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1StorageClass

deleteCollectionStorageClass

V1Status deleteCollectionStorageClass()

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

delete collection of StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionStorageClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. 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

deleteStorageClass

V1StorageClass deleteStorageClass()

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

delete a StorageClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteStorageClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the StorageClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1StorageClass

Volume Attachment

createVolumeAttachment

V1VolumeAttachment createVolumeAttachment(body)

create a VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateVolumeAttachmentRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateVolumeAttachmentRequest = {
  body: { /* See V1VolumeAttachment: /models/configuration-storage#v1volumeattachment */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createVolumeAttachment(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1VolumeAttachment
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

readVolumeAttachment

V1VolumeAttachment readVolumeAttachment()

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

read the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadVolumeAttachmentRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1VolumeAttachment

readVolumeAttachmentStatus

V1VolumeAttachment readVolumeAttachmentStatus()

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

read status of the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadVolumeAttachmentStatusRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1VolumeAttachment

listVolumeAttachment

V1VolumeAttachmentList listVolumeAttachment()

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

list or watch objects of kind VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListVolumeAttachmentRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachmentList

patchVolumeAttachment

V1VolumeAttachment patchVolumeAttachment(body)

partially update the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchVolumeAttachmentRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchVolumeAttachmentRequest = {
    // name of the VolumeAttachment
  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.patchVolumeAttachment(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the VolumeAttachment	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

patchVolumeAttachmentStatus

V1VolumeAttachment patchVolumeAttachmentStatus(body)

partially update status of the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchVolumeAttachmentStatusRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchVolumeAttachmentStatusRequest = {
    // name of the VolumeAttachment
  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.patchVolumeAttachmentStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the VolumeAttachment	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

replaceVolumeAttachment

V1VolumeAttachment replaceVolumeAttachment(body)

replace the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceVolumeAttachmentRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceVolumeAttachmentRequest = {
    // name of the VolumeAttachment
  name: "name_example",
  body: { /* See V1VolumeAttachment: /models/configuration-storage#v1volumeattachment */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceVolumeAttachment(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1VolumeAttachment
name	[string]	name of the VolumeAttachment	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

replaceVolumeAttachmentStatus

V1VolumeAttachment replaceVolumeAttachmentStatus(body)

replace status of the specified VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceVolumeAttachmentStatusRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceVolumeAttachmentStatusRequest = {
    // name of the VolumeAttachment
  name: "name_example",
  body: { /* See V1VolumeAttachment: /models/configuration-storage#v1volumeattachment */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceVolumeAttachmentStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1VolumeAttachment
name	[string]	name of the VolumeAttachment	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

deleteCollectionVolumeAttachment

V1Status deleteCollectionVolumeAttachment()

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

delete collection of VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionVolumeAttachmentRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. 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

deleteVolumeAttachment

V1VolumeAttachment deleteVolumeAttachment()

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

delete a VolumeAttachment

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteVolumeAttachmentRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the VolumeAttachment	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttachment

Volume Attributes Class

createVolumeAttributesClass

V1VolumeAttributesClass createVolumeAttributesClass(body)

create a VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiCreateVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiCreateVolumeAttributesClassRequest = {
  body: { /* See V1VolumeAttributesClass: /models/other#v1volumeattributesclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.createVolumeAttributesClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1VolumeAttributesClass
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttributesClass

readVolumeAttributesClass

V1VolumeAttributesClass readVolumeAttributesClass()

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

read the specified VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReadVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1VolumeAttributesClass

listVolumeAttributesClass

V1VolumeAttributesClassList listVolumeAttributesClass()

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

list or watch objects of kind VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiListVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttributesClassList

patchVolumeAttributesClass

V1VolumeAttributesClass patchVolumeAttributesClass(body)

partially update the specified VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiPatchVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiPatchVolumeAttributesClassRequest = {
    // name of the VolumeAttributesClass
  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.patchVolumeAttributesClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	any
name	[string]	name of the VolumeAttributesClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttributesClass

replaceVolumeAttributesClass

V1VolumeAttributesClass replaceVolumeAttributesClass(body)

replace the specified VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiReplaceVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

const request: StorageV1ApiReplaceVolumeAttributesClassRequest = {
    // name of the VolumeAttributesClass
  name: "name_example",
  body: { /* See V1VolumeAttributesClass: /models/other#v1volumeattributesclass */ },
    // If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
  pretty: "pretty_example",
    // When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
  dryRun: "dryRun_example",
    // fieldManager is a name associated with the actor or entity that is making these changes. The value must be 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.replaceVolumeAttributesClass(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1VolumeAttributesClass
name	[string]	name of the VolumeAttributesClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttributesClass

deleteCollectionVolumeAttributesClass

V1Status deleteCollectionVolumeAttributesClass()

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

delete collection of VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteCollectionVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
pretty	[string]	If 'true', then the output is pretty printed. 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

deleteVolumeAttributesClass

V1VolumeAttributesClass deleteVolumeAttributesClass()

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

delete a VolumeAttributesClass

Example

import { createConfiguration, StorageV1Api } from '@kubernetes/client-node';
import type { StorageV1ApiDeleteVolumeAttributesClassRequest } from '@kubernetes/client-node';

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

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

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the VolumeAttributesClass	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. 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

V1VolumeAttributesClass

APIResources

getAPIResources

V1APIResourceList getAPIResources()

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

get available resources

Example

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

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

const request = {};

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

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList