CustomObjectsApi
All URIs are relative to http://localhost
Cluster Custom Object
| Method | HTTP request | Description |
|---|---|---|
| createClusterCustomObject | POST /apis/{group}/{version}/{plural} | Creates a cluster scoped Custom object |
| listClusterCustomObject | GET /apis/{group}/{version}/{plural} | list or watch cluster scoped custom objects |
| patchClusterCustomObject | PATCH /apis/{group}/{version}/{plural}/{name} | patch the specified cluster scoped custom object |
| patchClusterCustomObjectScale | PATCH /apis/{group}/{version}/{plural}/{name}/scale | partially update scale of the specified cluster scoped custom object |
| patchClusterCustomObjectStatus | PATCH /apis/{group}/{version}/{plural}/{name}/status | partially update status of the specified cluster scoped custom object |
| replaceClusterCustomObject | PUT /apis/{group}/{version}/{plural}/{name} | replace the specified cluster scoped custom object |
| deleteClusterCustomObject | DELETE /apis/{group}/{version}/{plural}/{name} | Deletes the specified cluster scoped custom object |
| deleteCollectionClusterCustomObject | DELETE /apis/{group}/{version}/{plural} | Delete collection of cluster scoped custom objects |
| replaceClusterCustomObjectScale | PUT /apis/{group}/{version}/{plural}/{name}/scale | replace scale of the specified cluster scoped custom object |
| replaceClusterCustomObjectStatus | PUT /apis/{group}/{version}/{plural}/{name}/status | replace status of the cluster scoped specified custom object |
| getClusterCustomObject | GET /apis/{group}/{version}/{plural}/{name} | Returns a cluster scoped custom object |
| getClusterCustomObjectScale | GET /apis/{group}/{version}/{plural}/{name}/scale | read scale of the specified custom object |
| getClusterCustomObjectStatus | GET /apis/{group}/{version}/{plural}/{name}/status | read status of the specified cluster scoped custom object |
Custom Object
| Method | HTTP request | Description |
|---|---|---|
| createNamespacedCustomObject | POST /apis/{group}/{version}/namespaces/{namespace}/{plural} | Creates a namespace scoped Custom object |
| listNamespacedCustomObject | GET /apis/{group}/{version}/namespaces/{namespace}/{plural} | list or watch namespace scoped custom objects |
| listCustomObjectForAllNamespaces | GET /apis/{group}/{version}/{resource_plural} | list or watch namespace scoped custom objects |
| patchNamespacedCustomObject | PATCH /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | patch the specified namespace scoped custom object |
| patchNamespacedCustomObjectScale | PATCH /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | partially update scale of the specified namespace scoped custom object |
| patchNamespacedCustomObjectStatus | PATCH /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | partially update status of the specified namespace scoped custom object |
| replaceNamespacedCustomObject | PUT /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | replace the specified namespace scoped custom object |
| deleteCollectionNamespacedCustomObject | DELETE /apis/{group}/{version}/namespaces/{namespace}/{plural} | Delete collection of namespace scoped custom objects |
| deleteNamespacedCustomObject | DELETE /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | Deletes the specified namespace scoped custom object |
| replaceNamespacedCustomObjectScale | PUT /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | replace scale of the specified namespace scoped custom object |
| replaceNamespacedCustomObjectStatus | PUT /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | replace status of the specified namespace scoped custom object |
| getNamespacedCustomObject | GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name} | Returns a namespace scoped custom object |
| getNamespacedCustomObjectScale | GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/scale | read scale of the specified namespace scoped custom object |
| getNamespacedCustomObjectStatus | GET /apis/{group}/{version}/namespaces/{namespace}/{plural}/{name}/status | read status of the specified namespace scoped custom object |
APIResources
| Method | HTTP request | Description |
|---|---|---|
| getAPIResources | GET /apis/{group}/{version} | get available resources |
Cluster Custom Object
createClusterCustomObject
any createClusterCustomObject(body)
Creates a cluster scoped Custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiCreateClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiCreateClusterCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// The JSON schema of the Resource to create.
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to create. | |
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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
any
listClusterCustomObject
any listClusterCustomObject()
list or watch cluster scoped custom objects
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiListClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiListClusterCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...7 more optional parameter(s)
};
const data = await apiInstance.listClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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] | When specified with a watch call, shows changes that occur after that particular version of a resource. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) 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. More info | (optional) defaults to undefined |
Return type
any
patchClusterCustomObject
any patchClusterCustomObject(body)
patch the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchClusterCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom object\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The JSON schema of the Resource to patch.
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to patch. | |
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom object's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
patchClusterCustomObjectScale
any patchClusterCustomObjectScale(body)
partially update scale of the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchClusterCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchClusterCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchClusterCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
patchClusterCustomObjectStatus
any patchClusterCustomObjectStatus(body)
partially update status of the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchClusterCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchClusterCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchClusterCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
replaceClusterCustomObject
any replaceClusterCustomObject(body)
replace the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceClusterCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom object\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The JSON schema of the Resource to replace.
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to replace. | |
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom object's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
deleteClusterCustomObject
any deleteClusterCustomObject()
Deletes the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiDeleteClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiDeleteClusterCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom object\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
// Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
orphanDependents: true,
// Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional)
propagationPolicy: "propagationPolicy_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...1 more optional parameter(s)
};
const data = await apiInstance.deleteClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom object's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. 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 |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
Return type
any
deleteCollectionClusterCustomObject
any deleteCollectionClusterCustomObject()
Delete collection of cluster scoped custom objects
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiDeleteCollectionClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiDeleteCollectionClusterCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
labelSelector: "labelSelector_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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 |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. 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 |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
Return type
any
replaceClusterCustomObjectScale
any replaceClusterCustomObjectScale(body)
replace scale of the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceClusterCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceClusterCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceClusterCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
replaceClusterCustomObjectStatus
any replaceClusterCustomObjectStatus(body)
replace status of the cluster scoped specified custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceClusterCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceClusterCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceClusterCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
getClusterCustomObject
any getClusterCustomObject()
Returns a cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetClusterCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetClusterCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom object\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getClusterCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom object's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
getClusterCustomObjectScale
any getClusterCustomObjectScale()
read scale of the specified custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetClusterCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetClusterCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getClusterCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
getClusterCustomObjectStatus
any getClusterCustomObjectStatus()
read status of the specified cluster scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetClusterCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetClusterCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getClusterCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
Custom Object
createNamespacedCustomObject
any createNamespacedCustomObject(body)
Creates a namespace scoped Custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiCreateNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiCreateNamespacedCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// The JSON schema of the Resource to create.
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to create. | |
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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
any
listNamespacedCustomObject
any listNamespacedCustomObject()
list or watch namespace scoped custom objects
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiListNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiListNamespacedCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...7 more optional parameter(s)
};
const data = await apiInstance.listNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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] | When specified with a watch call, shows changes that occur after that particular version of a resource. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) 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. More info | (optional) defaults to undefined |
Return type
any
listCustomObjectForAllNamespaces
any listCustomObjectForAllNamespaces()
list or watch namespace scoped custom objects
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiListCustomObjectForAllNamespacesRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiListCustomObjectForAllNamespacesRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
resourcePlural: "resource_plural_example",
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...7 more optional parameter(s)
};
const data = await apiInstance.listCustomObjectForAllNamespaces(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| resourcePlural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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] | When specified with a watch call, shows changes that occur after that particular version of a resource. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) 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. More info | (optional) defaults to undefined |
Return type
any
patchNamespacedCustomObject
any patchNamespacedCustomObject(body)
patch the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchNamespacedCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The JSON schema of the Resource to patch.
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to patch. | |
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
patchNamespacedCustomObjectScale
any patchNamespacedCustomObjectScale(body)
partially update scale of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchNamespacedCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchNamespacedCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
patchNamespacedCustomObjectStatus
any patchNamespacedCustomObjectStatus(body)
partially update status of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiPatchNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiPatchNamespacedCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.patchNamespacedCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
replaceNamespacedCustomObject
any replaceNamespacedCustomObject(body)
replace the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceNamespacedCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The JSON schema of the Resource to replace.
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | The JSON schema of the Resource to replace. | |
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
deleteCollectionNamespacedCustomObject
any deleteCollectionNamespacedCustomObject()
Delete collection of namespace scoped custom objects
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiDeleteCollectionNamespacedCustomObjectRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// The custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// If \'true\', then the output is pretty printed. (optional)
pretty: "pretty_example",
// A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
labelSelector: "labelSelector_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...4 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | The custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. 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 |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. 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 |
| 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 |
Return type
any
deleteNamespacedCustomObject
any deleteNamespacedCustomObject()
Deletes the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiDeleteNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiDeleteNamespacedCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
// Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object\'s finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
orphanDependents: true,
// Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. (optional)
propagationPolicy: "propagationPolicy_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...1 more optional parameter(s)
};
const data = await apiInstance.deleteNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. 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 |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
Return type
any
replaceNamespacedCustomObjectScale
any replaceNamespacedCustomObjectScale(body)
replace scale of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceNamespacedCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceNamespacedCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
replaceNamespacedCustomObjectStatus
any replaceNamespacedCustomObjectStatus(body)
replace status of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiReplaceNamespacedCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
body: { /* See type definition in parameter table */ },
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. (optional) (optional)
fieldValidation: "fieldValidation_example",
};
const data = await apiInstance.replaceNamespacedCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. 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
any
getNamespacedCustomObject
any getNamespacedCustomObject()
Returns a namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetNamespacedCustomObjectRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetNamespacedCustomObjectRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getNamespacedCustomObject(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
getNamespacedCustomObjectScale
any getNamespacedCustomObjectScale()
read scale of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetNamespacedCustomObjectScaleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetNamespacedCustomObjectScaleRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getNamespacedCustomObjectScale(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
getNamespacedCustomObjectStatus
any getNamespacedCustomObjectStatus()
read status of the specified namespace scoped custom object
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetNamespacedCustomObjectStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetNamespacedCustomObjectStatusRequest = {
// the custom resource\'s group
group: "group_example",
// the custom resource\'s version
version: "version_example",
// The custom resource\'s namespace
namespace: "namespace_example",
// the custom resource\'s plural name. For TPRs this would be lowercase plural kind.
plural: "plural_example",
// the custom object\'s name
name: "name_example",
};
const data = await apiInstance.getNamespacedCustomObjectStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | the custom resource's group | defaults to undefined |
| version | [string] | the custom resource's version | defaults to undefined |
| namespace | [string] | The custom resource's namespace | defaults to undefined |
| plural | [string] | the custom resource's plural name. For TPRs this would be lowercase plural kind. | defaults to undefined |
| name | [string] | the custom object's name | defaults to undefined |
Return type
any
APIResources
getAPIResources
V1APIResourceList getAPIResources()
get available resources
Example
import { createConfiguration, CustomObjectsApi } from '@kubernetes/client-node';
import type { CustomObjectsApiGetAPIResourcesRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new CustomObjectsApi(configuration);
const request: CustomObjectsApiGetAPIResourcesRequest = {
// The custom resource\'s group name
group: "group_example",
// The custom resource\'s version
version: "version_example",
};
const data = await apiInstance.getAPIResources(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| group | [string] | The custom resource's group name | defaults to undefined |
| version | [string] | The custom resource's version | defaults to undefined |