Skip to main content

SchedulingV1alpha2Api

All URIs are relative to http://localhost

Pod Group​

MethodHTTP requestDescription
createNamespacedPodGroupPOST /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroupscreate a PodGroup
readNamespacedPodGroupGET /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}read the specified PodGroup
listNamespacedPodGroupGET /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroupslist or watch objects of kind PodGroup
readNamespacedPodGroupStatusGET /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}/statusread status of the specified PodGroup
listPodGroupForAllNamespacesGET /apis/scheduling.k8s.io/v1alpha2/podgroupslist or watch objects of kind PodGroup
patchNamespacedPodGroupPATCH /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}partially update the specified PodGroup
patchNamespacedPodGroupStatusPATCH /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}/statuspartially update status of the specified PodGroup
replaceNamespacedPodGroupPUT /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}replace the specified PodGroup
deleteCollectionNamespacedPodGroupDELETE /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroupsdelete collection of PodGroup
deleteNamespacedPodGroupDELETE /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}delete a PodGroup
replaceNamespacedPodGroupStatusPUT /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/podgroups/{name}/statusreplace status of the specified PodGroup

Workload​

MethodHTTP requestDescription
createNamespacedWorkloadPOST /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloadscreate a Workload
readNamespacedWorkloadGET /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloads/{name}read the specified Workload
listNamespacedWorkloadGET /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloadslist or watch objects of kind Workload
listWorkloadForAllNamespacesGET /apis/scheduling.k8s.io/v1alpha2/workloadslist or watch objects of kind Workload
patchNamespacedWorkloadPATCH /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloads/{name}partially update the specified Workload
replaceNamespacedWorkloadPUT /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloads/{name}replace the specified Workload
deleteCollectionNamespacedWorkloadDELETE /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloadsdelete collection of Workload
deleteNamespacedWorkloadDELETE /apis/scheduling.k8s.io/v1alpha2/namespaces/{namespace}/workloads/{name}delete a Workload

APIResources​

MethodHTTP requestDescription
getAPIResourcesGET /apis/scheduling.k8s.io/v1alpha2/get available resources

Pod Group​

createNamespacedPodGroup​

V1alpha2PodGroup createNamespacedPodGroup(body)

create a PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiCreateNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.createNamespacedPodGroup(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1alpha2PodGroup
namespace[string]object name and auth scope, such as for teams and projectsdefaults 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​

V1alpha2PodGroup

readNamespacedPodGroup​

V1alpha2PodGroup readNamespacedPodGroup()

read the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReadNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.readNamespacedPodGroup(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1alpha2PodGroup

listNamespacedPodGroup​

V1alpha2PodGroupList listNamespacedPodGroup()

list or watch objects of kind PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiListNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

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

V1alpha2PodGroupList

readNamespacedPodGroupStatus​

V1alpha2PodGroup readNamespacedPodGroupStatus()

read status of the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReadNamespacedPodGroupStatusRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.readNamespacedPodGroupStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1alpha2PodGroup

listPodGroupForAllNamespaces​

V1alpha2PodGroupList listPodGroupForAllNamespaces()

list or watch objects of kind PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiListPodGroupForAllNamespacesRequest } from '@kubernetes/client-node';

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

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

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

V1alpha2PodGroupList

patchNamespacedPodGroup​

V1alpha2PodGroup patchNamespacedPodGroup(body)

partially update the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiPatchNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.patchNamespacedPodGroup(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1alpha2PodGroup

patchNamespacedPodGroupStatus​

V1alpha2PodGroup patchNamespacedPodGroupStatus(body)

partially update status of the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiPatchNamespacedPodGroupStatusRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.patchNamespacedPodGroupStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1alpha2PodGroup

replaceNamespacedPodGroup​

V1alpha2PodGroup replaceNamespacedPodGroup(body)

replace the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReplaceNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.replaceNamespacedPodGroup(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1alpha2PodGroup
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults 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​

V1alpha2PodGroup

deleteCollectionNamespacedPodGroup​

V1Status deleteCollectionNamespacedPodGroup()

delete collection of PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiDeleteCollectionNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

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

V1Status

deleteNamespacedPodGroup​

V1Status deleteNamespacedPodGroup()

delete a PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiDeleteNamespacedPodGroupRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.deleteNamespacedPodGroup(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

replaceNamespacedPodGroupStatus​

V1alpha2PodGroup replaceNamespacedPodGroupStatus(body)

replace status of the specified PodGroup

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReplaceNamespacedPodGroupStatusRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.replaceNamespacedPodGroupStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1alpha2PodGroup
name[string]name of the PodGroupdefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults 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​

V1alpha2PodGroup

Workload​

createNamespacedWorkload​

V1alpha2Workload createNamespacedWorkload(body)

create a Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiCreateNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.createNamespacedWorkload(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1alpha2Workload
namespace[string]object name and auth scope, such as for teams and projectsdefaults 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​

V1alpha2Workload

readNamespacedWorkload​

V1alpha2Workload readNamespacedWorkload()

read the specified Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReadNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.readNamespacedWorkload(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the Workloaddefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1alpha2Workload

listNamespacedWorkload​

V1alpha2WorkloadList listNamespacedWorkload()

list or watch objects of kind Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiListNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

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

V1alpha2WorkloadList

listWorkloadForAllNamespaces​

V1alpha2WorkloadList listWorkloadForAllNamespaces()

list or watch objects of kind Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiListWorkloadForAllNamespacesRequest } from '@kubernetes/client-node';

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

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

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

V1alpha2WorkloadList

patchNamespacedWorkload​

V1alpha2Workload patchNamespacedWorkload(body)

partially update the specified Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiPatchNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.patchNamespacedWorkload(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the Workloaddefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1alpha2Workload

replaceNamespacedWorkload​

V1alpha2Workload replaceNamespacedWorkload(body)

replace the specified Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiReplaceNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.replaceNamespacedWorkload(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1alpha2Workload
name[string]name of the Workloaddefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults 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​

V1alpha2Workload

deleteCollectionNamespacedWorkload​

V1Status deleteCollectionNamespacedWorkload()

delete collection of Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiDeleteCollectionNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

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

V1Status

deleteNamespacedWorkload​

V1Status deleteNamespacedWorkload()

delete a Workload

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';
import type { SchedulingV1alpha2ApiDeleteNamespacedWorkloadRequest } from '@kubernetes/client-node';

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

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

const data = await apiInstance.deleteNamespacedWorkload(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the Workloaddefaults to undefined
namespace[string]object name and auth scope, such as for teams and projectsdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

APIResources​

getAPIResources​

V1APIResourceList getAPIResources()

get available resources

Example​
import { createConfiguration, SchedulingV1alpha2Api } from '@kubernetes/client-node';

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

const request = {};

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

This endpoint does not need any parameter.

Return type​

V1APIResourceList