Kazan v0.4.0 Kazan.Apis.BatchV1 View Source

Contains functions for the BatchV1 API.

Each of these functions will output a Kazan.Request suitable for passing to Kazan.Client.

Link to this section Summary

Functions

get available resources

get available resources

list or watch objects of kind Job

list or watch objects of kind Job

list or watch objects of kind Job

list or watch objects of kind Job

partially update status of the specified Job

partially update status of the specified Job

watch individual changes to a list of Job

watch individual changes to a list of Job

watch changes to an object of kind Job

watch changes to an object of kind Job

watch individual changes to a list of Job

watch individual changes to a list of Job

Link to this section Functions

Link to this function create_namespaced_job(body, namespace, options \\ []) View Source

create a Job

OpenAPI Operation ID: createBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function create_namespaced_job!(body, namespace, options \\ []) View Source

create a Job

OpenAPI Operation ID: createBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function delete_collection_namespaced_job(namespace, options \\ []) View Source

delete collection of Job

OpenAPI Operation ID: deleteBatchV1CollectionNamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.Status

Link to this function delete_collection_namespaced_job!(namespace, options \\ []) View Source

delete collection of Job

OpenAPI Operation ID: deleteBatchV1CollectionNamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.Status

Link to this function delete_namespaced_job(body, namespace, name, options \\ []) View Source

delete a Job

OpenAPI Operation ID: deleteBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • grace_period_seconds - 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 - 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 - 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.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.Status

Link to this function delete_namespaced_job!(body, namespace, name, options \\ []) View Source

delete a Job

OpenAPI Operation ID: deleteBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • grace_period_seconds - 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 - 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 - 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.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.Status

get available resources

OpenAPI Operation ID: getBatchV1APIResources

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.APIResourceList

get available resources

OpenAPI Operation ID: getBatchV1APIResources

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.APIResourceList

Link to this function list_job_for_all_namespaces(options \\ []) View Source

list or watch objects of kind Job

OpenAPI Operation ID: listBatchV1JobForAllNamespaces

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.Apis.Batch.V1.JobList

Link to this function list_job_for_all_namespaces!(options \\ []) View Source

list or watch objects of kind Job

OpenAPI Operation ID: listBatchV1JobForAllNamespaces

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.Apis.Batch.V1.JobList

Link to this function list_namespaced_job(namespace, options \\ []) View Source

list or watch objects of kind Job

OpenAPI Operation ID: listBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.Apis.Batch.V1.JobList

Link to this function list_namespaced_job!(namespace, options \\ []) View Source

list or watch objects of kind Job

OpenAPI Operation ID: listBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.Apis.Batch.V1.JobList

Link to this function patch_namespaced_job(body, namespace, name, options \\ []) View Source

partially update the specified Job

OpenAPI Operation ID: patchBatchV1NamespacedJob

Parameters

  • body - See Kazan.Models.ApiMachinery.Apis.Meta.V1.Patch.
  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function patch_namespaced_job!(body, namespace, name, options \\ []) View Source

partially update the specified Job

OpenAPI Operation ID: patchBatchV1NamespacedJob

Parameters

  • body - See Kazan.Models.ApiMachinery.Apis.Meta.V1.Patch.
  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function patch_namespaced_job_status(body, namespace, name, options \\ []) View Source

partially update status of the specified Job

OpenAPI Operation ID: patchBatchV1NamespacedJobStatus

Parameters

  • body - See Kazan.Models.ApiMachinery.Apis.Meta.V1.Patch.
  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function patch_namespaced_job_status!(body, namespace, name, options \\ []) View Source

partially update status of the specified Job

OpenAPI Operation ID: patchBatchV1NamespacedJobStatus

Parameters

  • body - See Kazan.Models.ApiMachinery.Apis.Meta.V1.Patch.
  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function read_namespaced_job(namespace, name, options \\ []) View Source

read the specified Job

OpenAPI Operation ID: readBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • exact - Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’.

  • export - Should this value be exported. Export strips fields that a user can not specify.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function read_namespaced_job!(namespace, name, options \\ []) View Source

read the specified Job

OpenAPI Operation ID: readBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

  • exact - Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’.

  • export - Should this value be exported. Export strips fields that a user can not specify.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function read_namespaced_job_status(namespace, name, options \\ []) View Source

read status of the specified Job

OpenAPI Operation ID: readBatchV1NamespacedJobStatus

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function read_namespaced_job_status!(namespace, name, options \\ []) View Source

read status of the specified Job

OpenAPI Operation ID: readBatchV1NamespacedJobStatus

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function replace_namespaced_job(body, namespace, name, options \\ []) View Source

replace the specified Job

OpenAPI Operation ID: replaceBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function replace_namespaced_job!(body, namespace, name, options \\ []) View Source

replace the specified Job

OpenAPI Operation ID: replaceBatchV1NamespacedJob

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function replace_namespaced_job_status(body, namespace, name, options \\ []) View Source

replace status of the specified Job

OpenAPI Operation ID: replaceBatchV1NamespacedJobStatus

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function replace_namespaced_job_status!(body, namespace, name, options \\ []) View Source

replace status of the specified Job

OpenAPI Operation ID: replaceBatchV1NamespacedJobStatus

Parameters

Options

  • pretty - If ‘true’, then the output is pretty printed.

Response

See Kazan.Models.Apis.Batch.V1.Job

Link to this function watch_job_list_for_all_namespaces(options \\ []) View Source

watch individual changes to a list of Job

OpenAPI Operation ID: watchBatchV1JobListForAllNamespaces

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent

Link to this function watch_job_list_for_all_namespaces!(options \\ []) View Source

watch individual changes to a list of Job

OpenAPI Operation ID: watchBatchV1JobListForAllNamespaces

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent

Link to this function watch_namespaced_job(namespace, name, options \\ []) View Source

watch changes to an object of kind Job

OpenAPI Operation ID: watchBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent

Link to this function watch_namespaced_job!(namespace, name, options \\ []) View Source

watch changes to an object of kind Job

OpenAPI Operation ID: watchBatchV1NamespacedJob

Parameters

  • namespace - object name and auth scope, such as for teams and projects
  • name - name of the Job

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent

Link to this function watch_namespaced_job_list(namespace, options \\ []) View Source

watch individual changes to a list of Job

OpenAPI Operation ID: watchBatchV1NamespacedJobList

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent

Link to this function watch_namespaced_job_list!(namespace, options \\ []) View Source

watch individual changes to a list of Job

OpenAPI Operation ID: watchBatchV1NamespacedJobList

Parameters

  • namespace - object name and auth scope, such as for teams and projects

Options

  • field_selector - A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • label_selector - A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • pretty - If ‘true’, then the output is pretty printed.

  • resource_version - 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.

  • timeout_seconds - Timeout for the list/watch call.

  • watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

See Kazan.Models.ApiMachinery.Apis.Meta.V1.WatchEvent