(create-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls POST on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs create a CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - include-uninitialized: optional boolean If IncludeUninitialized is specified, the object may be returned without completing initialization. - namespace: required string object name and auth scope, such as for teams and projects Returns v1beta1.CronJob
Calls POST on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs create a CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - include-uninitialized: optional boolean If IncludeUninitialized is specified, the object may be returned without completing initialization. - namespace: required string object name and auth scope, such as for teams and projects Returns v1beta1.CronJob
(delete-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls DELETE on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} delete a CronJob Parameters: - ctx: required server context - body: required v1.DeleteOptions Options: - body: optional v1.DeleteOptions - grace-period-seconds: optional 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. - orphan-dependents: optional 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. - propagation-policy: optional 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. - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1.Status
Calls DELETE on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} delete a CronJob Parameters: - ctx: required server context - body: required v1.DeleteOptions Options: - body: optional v1.DeleteOptions - grace-period-seconds: optional 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. - orphan-dependents: optional 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. - propagation-policy: optional 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. - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1.Status
(deletecollection-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__
opts?__10519__auto__])
Calls DELETE on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
delete collection of CronJob
Parameters:
- ctx: required server context
- body: required
Options:
- label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything.
- field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything.
- include-uninitialized: optional boolean If true, partially initialized resources are included in the response.
- limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. - namespace: required string object name and auth scope, such as for teams and projects Returns v1.Status
Calls DELETE on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs delete collection of CronJob Parameters: - ctx: required server context - body: required Options: - label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything. - field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything. - include-uninitialized: optional boolean If true, partially initialized resources are included in the response. - limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. - namespace: required string object name and auth scope, such as for teams and projects Returns v1.Status
(get-api-resources ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls GET on /apis/batch/v1beta1 get available resources Parameters: - ctx: required server context Returns
Calls GET on /apis/batch/v1beta1 get available resources Parameters: - ctx: required server context Returns
(list-cron-job-for-all-namespaces ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls GET on /apis/batch/v1beta1/cronjobs
list or watch objects of kind CronJob
Parameters:
- ctx: required server context
Options:
- label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything.
- field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything.
- include-uninitialized: optional boolean If true, partially initialized resources are included in the response.
- limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. Returns v1beta1.CronJobList
Calls GET on /apis/batch/v1beta1/cronjobs list or watch objects of kind CronJob Parameters: - ctx: required server context Options: - label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything. - field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything. - include-uninitialized: optional boolean If true, partially initialized resources are included in the response. - limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. Returns v1beta1.CronJobList
(list-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
list or watch objects of kind CronJob
Parameters:
- ctx: required server context
Options:
- label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything.
- field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything.
- include-uninitialized: optional boolean If true, partially initialized resources are included in the response.
- limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue
field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.
The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. - namespace: required string object name and auth scope, such as for teams and projects Returns v1beta1.CronJobList
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs list or watch objects of kind CronJob Parameters: - ctx: required server context Options: - label-selector: optional string A selector to restrict the list of returned objects by their labels. Defaults to everything. - field-selector: optional string A selector to restrict the list of returned objects by their fields. Defaults to everything. - include-uninitialized: optional boolean If true, partially initialized resources are included in the response. - limit: optional integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. - continue: optional 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 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. - namespace: required string object name and auth scope, such as for teams and projects Returns v1beta1.CronJobList
(patch-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls PATCH on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} partially update the specified CronJob Parameters: - ctx: required server context - body: required v1.Patch Options: - body: required v1.Patch - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls PATCH on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} partially update the specified CronJob Parameters: - ctx: required server context - body: required v1.Patch Options: - body: required v1.Patch - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
(patch-namespaced-cron-job-status ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls PATCH on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status partially update status of the specified CronJob Parameters: - ctx: required server context - body: required v1.Patch Options: - body: required v1.Patch - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls PATCH on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status partially update status of the specified CronJob Parameters: - ctx: required server context - body: required v1.Patch Options: - body: required v1.Patch - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
(read-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} read the specified CronJob Parameters: - ctx: required server context Options: - export: optional boolean Should this value be exported. Export strips fields that a user can not specify. - exact: optional boolean Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} read the specified CronJob Parameters: - ctx: required server context Options: - export: optional boolean Should this value be exported. Export strips fields that a user can not specify. - exact: optional boolean Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
(read-namespaced-cron-job-status ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status read status of the specified CronJob Parameters: - ctx: required server context Options: - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls GET on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status read status of the specified CronJob Parameters: - ctx: required server context Options: - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
(replace-namespaced-cron-job ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls PUT on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} replace the specified CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls PUT on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name} replace the specified CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
(replace-namespaced-cron-job-status ctx__10517__auto__
&
[body?__10518__auto__ opts?__10519__auto__])
Calls PUT on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status replace status of the specified CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
Calls PUT on /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status replace status of the specified CronJob Parameters: - ctx: required server context - body: required v1beta1.CronJob Options: - body: required v1beta1.CronJob - dry-run: optional string 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 - namespace: required string object name and auth scope, such as for teams and projects - name: required string name of the CronJob Returns v1beta1.CronJob
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close