FlowcontrolApiserverV1Api

readFlowSchema

V1FlowSchema readFlowSchema()

read the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReadFlowSchemaRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

listFlowSchema

V1FlowSchemaList listFlowSchema()

list or watch objects of kind FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiListFlowSchemaRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiListFlowSchemaRequest = {
    // 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",
  // ...8 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	`sendInitialEvents=true` may be set together with `watch=true`. More info	(optional) defaults to undefined
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

V1FlowSchemaList

readFlowSchemaStatus

V1FlowSchema readFlowSchemaStatus()

read status of the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReadFlowSchemaStatusRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

patchFlowSchema

V1FlowSchema patchFlowSchema(body)

partially update the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiPatchFlowSchemaRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

patchFlowSchemaStatus

V1FlowSchema patchFlowSchemaStatus(body)

partially update status of the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiPatchFlowSchemaStatusRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

replaceFlowSchema

V1FlowSchema replaceFlowSchema(body)

replace the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaRequest = {
    // name of the FlowSchema
  name: "name_example",
  body: { /* See V1FlowSchema: /models/configuration-storage#v1flowschema */ },
    // 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.replaceFlowSchema(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1FlowSchema
name	[string]	name of the FlowSchema	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

deleteCollectionFlowSchema

V1Status deleteCollectionFlowSchema()

delete collection of FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiDeleteCollectionFlowSchemaRequest = {
    // 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 */ },
  // ...11 more optional parameter(s)
};

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

Parameters

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

deleteFlowSchema

V1Status deleteFlowSchema()

delete a FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiDeleteFlowSchemaRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

replaceFlowSchemaStatus

V1FlowSchema replaceFlowSchemaStatus(body)

replace status of the specified FlowSchema

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiReplaceFlowSchemaStatusRequest = {
    // name of the FlowSchema
  name: "name_example",
  body: { /* See V1FlowSchema: /models/configuration-storage#v1flowschema */ },
    // 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.replaceFlowSchemaStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1FlowSchema
name	[string]	name of the FlowSchema	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

Priority Level Configuration

createPriorityLevelConfiguration

V1PriorityLevelConfiguration createPriorityLevelConfiguration(body)

create a PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiCreatePriorityLevelConfigurationRequest = {
  body: { /* See V1PriorityLevelConfiguration: /models/configuration-storage#v1prioritylevelconfiguration */ },
    // 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.createPriorityLevelConfiguration(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1PriorityLevelConfiguration
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

readPriorityLevelConfiguration

V1PriorityLevelConfiguration readPriorityLevelConfiguration()

read the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

V1PriorityLevelConfigurationList

listPriorityLevelConfiguration

V1PriorityLevelConfigurationList listPriorityLevelConfiguration()

list or watch objects of kind PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiListPriorityLevelConfigurationRequest = {
    // 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",
  // ...8 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined
allowWatchBookmarks	[boolean]	allowWatchBookmarks requests watch events with type "BOOKMARK". More info	(optional) defaults to undefined
_continue	[string]	The continue option should be set when retrieving more results from the server. More info	(optional) defaults to undefined
fieldSelector	[string]	A selector to restrict the list of returned objects by their fields. Defaults to everything. More info	(optional) defaults to undefined
labelSelector	[string]	A selector to restrict the list of returned objects by their labels. Defaults to everything. More info	(optional) defaults to undefined
limit	[number]	limit is a maximum number of responses to return for a list call. More info	(optional) defaults to undefined
resourceVersion	[string]	resourceVersion sets a constraint on what resource versions a request may be served from. More info	(optional) defaults to undefined
resourceVersionMatch	[string]	resourceVersionMatch determines how resourceVersion is applied to list calls. More info	(optional) defaults to undefined
sendInitialEvents	[boolean]	`sendInitialEvents=true` may be set together with `watch=true`. More info	(optional) defaults to undefined
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

readPriorityLevelConfigurationStatus

V1PriorityLevelConfiguration readPriorityLevelConfigurationStatus()

read status of the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReadPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

patchPriorityLevelConfiguration

V1PriorityLevelConfiguration patchPriorityLevelConfiguration(body)

partially update the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

patchPriorityLevelConfigurationStatus

V1PriorityLevelConfiguration patchPriorityLevelConfigurationStatus(body)

partially update status of the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiPatchPriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

replacePriorityLevelConfiguration

V1PriorityLevelConfiguration replacePriorityLevelConfiguration(body)

replace the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationRequest = {
    // name of the PriorityLevelConfiguration
  name: "name_example",
  body: { /* See V1PriorityLevelConfiguration: /models/configuration-storage#v1prioritylevelconfiguration */ },
    // 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.replacePriorityLevelConfiguration(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1PriorityLevelConfiguration
name	[string]	name of the PriorityLevelConfiguration	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

deleteCollectionPriorityLevelConfiguration

V1Status deleteCollectionPriorityLevelConfiguration()

delete collection of PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiDeleteCollectionPriorityLevelConfigurationRequest = {
    // 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 */ },
  // ...11 more optional parameter(s)
};

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

Parameters

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

deletePriorityLevelConfiguration

V1Status deletePriorityLevelConfiguration()

delete a PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiDeletePriorityLevelConfigurationRequest } from '@kubernetes/client-node';

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

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

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

Parameters

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

Return type

replacePriorityLevelConfigurationStatus

V1PriorityLevelConfiguration replacePriorityLevelConfigurationStatus(body)

replace status of the specified PriorityLevelConfiguration

Example

import { createConfiguration, FlowcontrolApiserverV1Api } from '@kubernetes/client-node';
import type { FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest } from '@kubernetes/client-node';

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

const request: FlowcontrolApiserverV1ApiReplacePriorityLevelConfigurationStatusRequest = {
    // name of the PriorityLevelConfiguration
  name: "name_example",
  body: { /* See V1PriorityLevelConfiguration: /models/configuration-storage#v1prioritylevelconfiguration */ },
    // 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.replacePriorityLevelConfigurationStatus(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
body	V1PriorityLevelConfiguration
name	[string]	name of the PriorityLevelConfiguration	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