Kazan v0.1.0 Kazan.Apis.BatchV1

Contains functions for the BatchV1 API.

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

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

Functions

create_namespaced_job(body, namespace, options \\ [])

create a Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • namespace - object name and auth scope, such as for teams and projects

Options

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

Response

See Kazan.Models.V1.Job

create_namespaced_job!(body, namespace, options \\ [])

create a Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • namespace - object name and auth scope, such as for teams and projects

Options

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

Response

See Kazan.Models.V1.Job

delete_collection_namespaced_job(namespace, options \\ [])

delete collection of Job

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.

  • 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.Unversioned.Status

delete_collection_namespaced_job!(namespace, options \\ [])

delete collection of Job

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.

  • 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.Unversioned.Status

delete_namespaced_job(body, namespace, name, options \\ [])

delete a Job

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 - Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list.

Response

See Kazan.Models.Unversioned.Status

delete_namespaced_job!(body, namespace, name, options \\ [])

delete a Job

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 - Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list.

Response

See Kazan.Models.Unversioned.Status

get_api_resources()

get available resources

Response

See Kazan.Models.Unversioned.APIResourceList

get_api_resources!()

get available resources

Response

See Kazan.Models.Unversioned.APIResourceList

list_job_for_all_namespaces(options \\ [])

list or watch objects of kind 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.

  • 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.V1.JobList

list_job_for_all_namespaces!(options \\ [])

list or watch objects of kind 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.

  • 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.V1.JobList

list_namespaced_job(namespace, options \\ [])

list or watch objects of kind Job

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.

  • 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.V1.JobList

list_namespaced_job!(namespace, options \\ [])

list or watch objects of kind Job

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.

  • 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.V1.JobList

patch_namespaced_job(body, namespace, name, options \\ [])

partially update the specified Job

Parameters

  • body - See Kazan.Models.Unversioned.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.V1.Job

patch_namespaced_job!(body, namespace, name, options \\ [])

partially update the specified Job

Parameters

  • body - See Kazan.Models.Unversioned.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.V1.Job

patch_namespaced_job_status(body, namespace, name, options \\ [])

partially update status of the specified Job

Parameters

  • body - See Kazan.Models.Unversioned.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.V1.Job

patch_namespaced_job_status!(body, namespace, name, options \\ [])

partially update status of the specified Job

Parameters

  • body - See Kazan.Models.Unversioned.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.V1.Job

read_namespaced_job(namespace, name, options \\ [])

read the specified Job

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.V1.Job

read_namespaced_job!(namespace, name, options \\ [])

read the specified Job

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.V1.Job

read_namespaced_job_status(namespace, name, options \\ [])

read status of the specified Job

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.V1.Job

read_namespaced_job_status!(namespace, name, options \\ [])

read status of the specified Job

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.V1.Job

replace_namespaced_job(body, namespace, name, options \\ [])

replace the specified Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • 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.V1.Job

replace_namespaced_job!(body, namespace, name, options \\ [])

replace the specified Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • 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.V1.Job

replace_namespaced_job_status(body, namespace, name, options \\ [])

replace status of the specified Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • 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.V1.Job

replace_namespaced_job_status!(body, namespace, name, options \\ [])

replace status of the specified Job

Parameters

  • body - See Kazan.Models.V1.Job.
  • 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.V1.Job

watch_job_list_for_all_namespaces(options \\ [])

watch individual changes to a list of 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.

  • 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.Versioned.Event

watch_job_list_for_all_namespaces!(options \\ [])

watch individual changes to a list of 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.

  • 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.Versioned.Event

watch_namespaced_job(namespace, name, options \\ [])

watch changes to an object of kind Job

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.

  • 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.Versioned.Event

watch_namespaced_job!(namespace, name, options \\ [])

watch changes to an object of kind Job

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.

  • 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.Versioned.Event

watch_namespaced_job_list(namespace, options \\ [])

watch individual changes to a list of Job

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.

  • 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.Versioned.Event

watch_namespaced_job_list!(namespace, options \\ [])

watch individual changes to a list of Job

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.

  • 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.Versioned.Event