Files
c/kubernetes/docs/StorageV1API.md

102 KiB

StorageV1API

All URIs are relative to http://localhost

Method HTTP request Description
StorageV1API_createCSIDriver POST /apis/storage.k8s.io/v1/csidrivers
StorageV1API_createCSINode POST /apis/storage.k8s.io/v1/csinodes
StorageV1API_createStorageClass POST /apis/storage.k8s.io/v1/storageclasses
StorageV1API_createVolumeAttachment POST /apis/storage.k8s.io/v1/volumeattachments
StorageV1API_deleteCSIDriver DELETE /apis/storage.k8s.io/v1/csidrivers/{name}
StorageV1API_deleteCSINode DELETE /apis/storage.k8s.io/v1/csinodes/{name}
StorageV1API_deleteCollectionCSIDriver DELETE /apis/storage.k8s.io/v1/csidrivers
StorageV1API_deleteCollectionCSINode DELETE /apis/storage.k8s.io/v1/csinodes
StorageV1API_deleteCollectionStorageClass DELETE /apis/storage.k8s.io/v1/storageclasses
StorageV1API_deleteCollectionVolumeAttachment DELETE /apis/storage.k8s.io/v1/volumeattachments
StorageV1API_deleteStorageClass DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
StorageV1API_deleteVolumeAttachment DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}
StorageV1API_getAPIResources GET /apis/storage.k8s.io/v1/
StorageV1API_listCSIDriver GET /apis/storage.k8s.io/v1/csidrivers
StorageV1API_listCSINode GET /apis/storage.k8s.io/v1/csinodes
StorageV1API_listStorageClass GET /apis/storage.k8s.io/v1/storageclasses
StorageV1API_listVolumeAttachment GET /apis/storage.k8s.io/v1/volumeattachments
StorageV1API_patchCSIDriver PATCH /apis/storage.k8s.io/v1/csidrivers/{name}
StorageV1API_patchCSINode PATCH /apis/storage.k8s.io/v1/csinodes/{name}
StorageV1API_patchStorageClass PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
StorageV1API_patchVolumeAttachment PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}
StorageV1API_patchVolumeAttachmentStatus PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status
StorageV1API_readCSIDriver GET /apis/storage.k8s.io/v1/csidrivers/{name}
StorageV1API_readCSINode GET /apis/storage.k8s.io/v1/csinodes/{name}
StorageV1API_readStorageClass GET /apis/storage.k8s.io/v1/storageclasses/{name}
StorageV1API_readVolumeAttachment GET /apis/storage.k8s.io/v1/volumeattachments/{name}
StorageV1API_readVolumeAttachmentStatus GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status
StorageV1API_replaceCSIDriver PUT /apis/storage.k8s.io/v1/csidrivers/{name}
StorageV1API_replaceCSINode PUT /apis/storage.k8s.io/v1/csinodes/{name}
StorageV1API_replaceStorageClass PUT /apis/storage.k8s.io/v1/storageclasses/{name}
StorageV1API_replaceVolumeAttachment PUT /apis/storage.k8s.io/v1/volumeattachments/{name}
StorageV1API_replaceVolumeAttachmentStatus PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status

StorageV1API_createCSIDriver

// create a CSIDriver
//
v1_csi_driver_t* StorageV1API_createCSIDriver(apiClient_t *apiClient, v1_csi_driver_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_csi_driver_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_csi_driver_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_createCSINode

// create a CSINode
//
v1_csi_node_t* StorageV1API_createCSINode(apiClient_t *apiClient, v1_csi_node_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_csi_node_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_csi_node_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_createStorageClass

// create a StorageClass
//
v1_storage_class_t* StorageV1API_createStorageClass(apiClient_t *apiClient, v1_storage_class_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_storage_class_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_storage_class_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_createVolumeAttachment

// create a VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_createVolumeAttachment(apiClient_t *apiClient, v1_volume_attachment_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body v1_volume_attachment_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCSIDriver

// delete a CSIDriver
//
v1_csi_driver_t* StorageV1API_deleteCSIDriver(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSIDriver
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
body v1_delete_options_t * [optional]

Return type

v1_csi_driver_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCSINode

// delete a CSINode
//
v1_csi_node_t* StorageV1API_deleteCSINode(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSINode
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
body v1_delete_options_t * [optional]

Return type

v1_csi_node_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCollectionCSIDriver

// delete collection of CSIDriver
//
v1_status_t* StorageV1API_deleteCollectionCSIDriver(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCollectionCSINode

// delete collection of CSINode
//
v1_status_t* StorageV1API_deleteCollectionCSINode(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCollectionStorageClass

// delete collection of StorageClass
//
v1_status_t* StorageV1API_deleteCollectionStorageClass(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteCollectionVolumeAttachment

// delete collection of VolumeAttachment
//
v1_status_t* StorageV1API_deleteCollectionVolumeAttachment(apiClient_t *apiClient, char * pretty, char * _continue, char * dryRun, char * fieldSelector, int gracePeriodSeconds, char * labelSelector, int limit, int orphanDependents, char * propagationPolicy, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
body v1_delete_options_t * [optional]

Return type

v1_status_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteStorageClass

// delete a StorageClass
//
v1_storage_class_t* StorageV1API_deleteStorageClass(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the StorageClass
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
body v1_delete_options_t * [optional]

Return type

v1_storage_class_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_deleteVolumeAttachment

// delete a VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_deleteVolumeAttachment(apiClient_t *apiClient, char * name, char * pretty, char * dryRun, int gracePeriodSeconds, int orphanDependents, char * propagationPolicy, v1_delete_options_t * body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
gracePeriodSeconds int The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. [optional]
orphanDependents int Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. [optional]
propagationPolicy char * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. [optional]
body v1_delete_options_t * [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_getAPIResources

// get available resources
//
v1_api_resource_list_t* StorageV1API_getAPIResources(apiClient_t *apiClient);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration

Return type

v1_api_resource_list_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_listCSIDriver

// list or watch objects of kind CSIDriver
//
v1_csi_driver_list_t* StorageV1API_listCSIDriver(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_csi_driver_list_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_listCSINode

// list or watch objects of kind CSINode
//
v1_csi_node_list_t* StorageV1API_listCSINode(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_csi_node_list_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_listStorageClass

// list or watch objects of kind StorageClass
//
v1_storage_class_list_t* StorageV1API_listStorageClass(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_storage_class_list_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_listVolumeAttachment

// list or watch objects of kind VolumeAttachment
//
v1_volume_attachment_list_t* StorageV1API_listVolumeAttachment(apiClient_t *apiClient, char * pretty, int allowWatchBookmarks, char * _continue, char * fieldSelector, char * labelSelector, int limit, char * resourceVersion, char * resourceVersionMatch, int timeoutSeconds, int watch);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pretty char * If 'true', then the output is pretty printed. [optional]
allowWatchBookmarks int allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. [optional]
_continue char * The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. [optional]
fieldSelector char * A selector to restrict the list of returned objects by their fields. Defaults to everything. [optional]
labelSelector char * A selector to restrict the list of returned objects by their labels. Defaults to everything. [optional]
limit int limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. [optional]
resourceVersion char * resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
resourceVersionMatch char * resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset [optional]
timeoutSeconds int Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. [optional]
watch int Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. [optional]

Return type

v1_volume_attachment_list_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_patchCSIDriver

// partially update the specified CSIDriver
//
v1_csi_driver_t* StorageV1API_patchCSIDriver(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSIDriver
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_csi_driver_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_patchCSINode

// partially update the specified CSINode
//
v1_csi_node_t* StorageV1API_patchCSINode(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSINode
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_csi_node_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_patchStorageClass

// partially update the specified StorageClass
//
v1_storage_class_t* StorageV1API_patchStorageClass(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the StorageClass
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_storage_class_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_patchVolumeAttachment

// partially update the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_patchVolumeAttachment(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_patchVolumeAttachmentStatus

// partially update status of the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_patchVolumeAttachmentStatus(apiClient_t *apiClient, char * name, object_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation, int force);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
body object_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]
force int Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json, application/apply-patch+yaml
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_readCSIDriver

// read the specified CSIDriver
//
v1_csi_driver_t* StorageV1API_readCSIDriver(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSIDriver
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1_csi_driver_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_readCSINode

// read the specified CSINode
//
v1_csi_node_t* StorageV1API_readCSINode(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSINode
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1_csi_node_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_readStorageClass

// read the specified StorageClass
//
v1_storage_class_t* StorageV1API_readStorageClass(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the StorageClass
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1_storage_class_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_readVolumeAttachment

// read the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_readVolumeAttachment(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_readVolumeAttachmentStatus

// read status of the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_readVolumeAttachmentStatus(apiClient_t *apiClient, char * name, char * pretty);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
pretty char * If 'true', then the output is pretty printed. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_replaceCSIDriver

// replace the specified CSIDriver
//
v1_csi_driver_t* StorageV1API_replaceCSIDriver(apiClient_t *apiClient, char * name, v1_csi_driver_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSIDriver
body v1_csi_driver_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_csi_driver_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_replaceCSINode

// replace the specified CSINode
//
v1_csi_node_t* StorageV1API_replaceCSINode(apiClient_t *apiClient, char * name, v1_csi_node_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the CSINode
body v1_csi_node_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_csi_node_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_replaceStorageClass

// replace the specified StorageClass
//
v1_storage_class_t* StorageV1API_replaceStorageClass(apiClient_t *apiClient, char * name, v1_storage_class_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the StorageClass
body v1_storage_class_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_storage_class_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_replaceVolumeAttachment

// replace the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_replaceVolumeAttachment(apiClient_t *apiClient, char * name, v1_volume_attachment_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
body v1_volume_attachment_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StorageV1API_replaceVolumeAttachmentStatus

// replace status of the specified VolumeAttachment
//
v1_volume_attachment_t* StorageV1API_replaceVolumeAttachmentStatus(apiClient_t *apiClient, char * name, v1_volume_attachment_t * body, char * pretty, char * dryRun, char * fieldManager, char * fieldValidation);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
name char * name of the VolumeAttachment
body v1_volume_attachment_t *
pretty char * If 'true', then the output is pretty printed. [optional]
dryRun char * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed [optional]
fieldManager char * fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. [optional]
fieldValidation char * fieldValidation determines how the server should respond to unknown/duplicate fields in the object in the request. Introduced as alpha in 1.23, older servers or servers with the `ServerSideFieldValidation` feature disabled will discard valid values specified in this param and not perform any server side field validation. Valid values are: - Ignore: ignores unknown/duplicate fields. - Warn: responds with a warning for each unknown/duplicate field, but successfully serves the request. - Strict: fails the request on unknown/duplicate fields. [optional]

Return type

v1_volume_attachment_t *

Authorization

BearerToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]