@datafire/kubernetes v4.0.0
@datafire/kubernetes
Client library for Kubernetes
Installation and Usage
npm install --save @datafire/kubernetes
let kubernetes = require('@datafire/kubernetes').create({
BearerToken: ""
});
.then(data => {
console.log(data);
});
Description
Actions
getCoreAPIVersions
get available API versions
kubernetes.getCoreAPIVersions(null, context)
Input
This action has no parameters
Output
getCoreV1APIResources
get available resources
kubernetes.getCoreV1APIResources(null, context)
Input
This action has no parameters
Output
listCoreV1ComponentStatus
list objects of kind ComponentStatus
kubernetes.listCoreV1ComponentStatus({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - pretty
string
: If 'true', then the output is pretty printed. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
- continue
Output
readCoreV1ComponentStatus
read the specified ComponentStatus
kubernetes.readCoreV1ComponentStatus({
"name": ""
}, context)
Input
- input
object
- name required
string
: name of the ComponentStatus - pretty
string
: If 'true', then the output is pretty printed.
- name required
Output
listCoreV1ConfigMapForAllNamespaces
list or watch objects of kind ConfigMap
kubernetes.listCoreV1ConfigMapForAllNamespaces({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - pretty
string
: If 'true', then the output is pretty printed. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
- continue
Output
listCoreV1EndpointsForAllNamespaces
list or watch objects of kind Endpoints
kubernetes.listCoreV1EndpointsForAllNamespaces({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - pretty
string
: If 'true', then the output is pretty printed. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
- continue
Output
listCoreV1EventForAllNamespaces
list or watch objects of kind Event
kubernetes.listCoreV1EventForAllNamespaces({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - pretty
string
: If 'true', then the output is pretty printed. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
- continue
Output
- output io.k8s.api.core.v1.EventList
listCoreV1LimitRangeForAllNamespaces
list or watch objects of kind LimitRange
kubernetes.listCoreV1LimitRangeForAllNamespaces({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - pretty
string
: If 'true', then the output is pretty printed. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
- continue
Output
listCoreV1Namespace
list or watch objects of kind Namespace
kubernetes.listCoreV1Namespace({}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
createCoreV1Namespace
create a Namespace
kubernetes.createCoreV1Namespace({
"body": null
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Namespace
- pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Namespace
createCoreV1NamespacedBinding
create a Binding
kubernetes.createCoreV1NamespacedBinding({
"body": null,
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Binding
- namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Binding
deleteCoreV1CollectionNamespacedConfigMap
delete collection of ConfigMap
kubernetes.deleteCoreV1CollectionNamespacedConfigMap({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
listCoreV1NamespacedConfigMap
list or watch objects of kind ConfigMap
kubernetes.listCoreV1NamespacedConfigMap({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
createCoreV1NamespacedConfigMap
create a ConfigMap
kubernetes.createCoreV1NamespacedConfigMap({
"body": null,
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.ConfigMap
- namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.ConfigMap
deleteCoreV1NamespacedConfigMap
delete a ConfigMap
kubernetes.deleteCoreV1NamespacedConfigMap({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions
- gracePeriodSeconds
integer
: 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. - orphanDependents
boolean
: Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - propagationPolicy
string
: Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. - name required
string
: name of the ConfigMap - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
readCoreV1NamespacedConfigMap
read the specified ConfigMap
kubernetes.readCoreV1NamespacedConfigMap({
"name": "",
"namespace": ""
}, context)
Input
- input
object
- exact
boolean
: Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - export
boolean
: Should this value be exported. Export strips fields that a user can not specify. - name required
string
: name of the ConfigMap - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- exact
Output
- output io.k8s.api.core.v1.ConfigMap
patchCoreV1NamespacedConfigMap
partially update the specified ConfigMap
kubernetes.patchCoreV1NamespacedConfigMap({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.Patch
- name required
string
: name of the ConfigMap - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.ConfigMap
replaceCoreV1NamespacedConfigMap
replace the specified ConfigMap
kubernetes.replaceCoreV1NamespacedConfigMap({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.ConfigMap
- name required
string
: name of the ConfigMap - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.ConfigMap
deleteCoreV1CollectionNamespacedEndpoints
delete collection of Endpoints
kubernetes.deleteCoreV1CollectionNamespacedEndpoints({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
listCoreV1NamespacedEndpoints
list or watch objects of kind Endpoints
kubernetes.listCoreV1NamespacedEndpoints({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
createCoreV1NamespacedEndpoints
create Endpoints
kubernetes.createCoreV1NamespacedEndpoints({
"body": null,
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Endpoints
- namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Endpoints
deleteCoreV1NamespacedEndpoints
delete Endpoints
kubernetes.deleteCoreV1NamespacedEndpoints({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions
- gracePeriodSeconds
integer
: 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. - orphanDependents
boolean
: Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - propagationPolicy
string
: Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. - name required
string
: name of the Endpoints - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
readCoreV1NamespacedEndpoints
read the specified Endpoints
kubernetes.readCoreV1NamespacedEndpoints({
"name": "",
"namespace": ""
}, context)
Input
- input
object
- exact
boolean
: Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - export
boolean
: Should this value be exported. Export strips fields that a user can not specify. - name required
string
: name of the Endpoints - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- exact
Output
- output io.k8s.api.core.v1.Endpoints
patchCoreV1NamespacedEndpoints
partially update the specified Endpoints
kubernetes.patchCoreV1NamespacedEndpoints({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.Patch
- name required
string
: name of the Endpoints - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Endpoints
replaceCoreV1NamespacedEndpoints
replace the specified Endpoints
kubernetes.replaceCoreV1NamespacedEndpoints({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Endpoints
- name required
string
: name of the Endpoints - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Endpoints
deleteCoreV1CollectionNamespacedEvent
delete collection of Event
kubernetes.deleteCoreV1CollectionNamespacedEvent({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
listCoreV1NamespacedEvent
list or watch objects of kind Event
kubernetes.listCoreV1NamespacedEvent({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
- output io.k8s.api.core.v1.EventList
createCoreV1NamespacedEvent
create an Event
kubernetes.createCoreV1NamespacedEvent({
"body": null,
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Event
- namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Event
deleteCoreV1NamespacedEvent
delete an Event
kubernetes.deleteCoreV1NamespacedEvent({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions
- gracePeriodSeconds
integer
: 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. - orphanDependents
boolean
: Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - propagationPolicy
string
: Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. - name required
string
: name of the Event - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
readCoreV1NamespacedEvent
read the specified Event
kubernetes.readCoreV1NamespacedEvent({
"name": "",
"namespace": ""
}, context)
Input
- input
object
- exact
boolean
: Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - export
boolean
: Should this value be exported. Export strips fields that a user can not specify. - name required
string
: name of the Event - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- exact
Output
- output io.k8s.api.core.v1.Event
patchCoreV1NamespacedEvent
partially update the specified Event
kubernetes.patchCoreV1NamespacedEvent({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.Patch
- name required
string
: name of the Event - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Event
replaceCoreV1NamespacedEvent
replace the specified Event
kubernetes.replaceCoreV1NamespacedEvent({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.Event
- name required
string
: name of the Event - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
- output io.k8s.api.core.v1.Event
deleteCoreV1CollectionNamespacedLimitRange
delete collection of LimitRange
kubernetes.deleteCoreV1CollectionNamespacedLimitRange({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
listCoreV1NamespacedLimitRange
list or watch objects of kind LimitRange
kubernetes.listCoreV1NamespacedLimitRange({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
createCoreV1NamespacedLimitRange
create a LimitRange
kubernetes.createCoreV1NamespacedLimitRange({
"body": null,
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.LimitRange
- namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
deleteCoreV1NamespacedLimitRange
delete a LimitRange
kubernetes.deleteCoreV1NamespacedLimitRange({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions
- gracePeriodSeconds
integer
: 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. - orphanDependents
boolean
: Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. - propagationPolicy
string
: Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. - name required
string
: name of the LimitRange - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
readCoreV1NamespacedLimitRange
read the specified LimitRange
kubernetes.readCoreV1NamespacedLimitRange({
"name": "",
"namespace": ""
}, context)
Input
- input
object
- exact
boolean
: Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - export
boolean
: Should this value be exported. Export strips fields that a user can not specify. - name required
string
: name of the LimitRange - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- exact
Output
patchCoreV1NamespacedLimitRange
partially update the specified LimitRange
kubernetes.patchCoreV1NamespacedLimitRange({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.apimachinery.pkg.apis.meta.v1.Patch
- name required
string
: name of the LimitRange - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
replaceCoreV1NamespacedLimitRange
replace the specified LimitRange
kubernetes.replaceCoreV1NamespacedLimitRange({
"body": null,
"name": "",
"namespace": ""
}, context)
Input
- input
object
- body required io.k8s.api.core.v1.LimitRange
- name required
string
: name of the LimitRange - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
Output
deleteCoreV1CollectionNamespacedPersistentVolumeClaim
delete collection of PersistentVolumeClaim
kubernetes.deleteCoreV1CollectionNamespacedPersistentVolumeClaim({
"namespace": ""
}, context)
Input
- input
object
- continue
string
: 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 indicating the client must restart their list without the continue field. 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. - fieldSelector
string
: A selector to restrict the list of returned objects by their fields. Defaults to everything. - includeUninitialized
boolean
: If true, partially initialized resources are included in the response. - labelSelector
string
: A selector to restrict the list of returned objects by their labels. Defaults to everything. - limit
integer
: limit is a maximum number of responses to return for a list call. If more items exist, the server will set thecontinue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. - resourceVersion
string
: When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. - timeoutSeconds
integer
: Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. - watch
boolean
: Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - namespace required
string
: object name and auth scope, such as for teams and projects - pretty
string
: If 'true', then the output is pretty printed.
- continue
Output
listCoreV1NamespacedPersistentVolumeClaim
list or watch objects of kind PersistentVolumeClaim
kubernetes.listCoreV1NamespacedPersistentVolumeClaim({
"namespace": ""
}, conte