Kazan v0.10.0 Kazan.Apis.Storage.V1alpha1 View Source

Contains functions for V1alpha1 of the Storage API group.

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

This module also contains struct submodules that can be sent & received from this version of the Storage API.

Link to this section Summary

Functions

delete collection of VolumeAttachment

delete collection of VolumeAttachment

get available resources

get available resources

list or watch objects of kind VolumeAttachment

list or watch objects of kind VolumeAttachment

partially update the specified VolumeAttachment

partially update the specified VolumeAttachment

read the specified VolumeAttachment

read the specified VolumeAttachment

replace the specified VolumeAttachment

replace the specified VolumeAttachment

watch changes to an object of kind VolumeAttachment

watch changes to an object of kind VolumeAttachment

watch individual changes to a list of VolumeAttachment

watch individual changes to a list of VolumeAttachment

Link to this section Functions

Link to this function create_volume_attachment!(body, options \\ []) View Source
create_volume_attachment!(Kazan.Apis.Storage.V1alpha1.VolumeAttachment.t(), [
  {:pretty, String.t()}
]) :: Kazan.Request.t()

create a VolumeAttachment

OpenAPI Operation ID: createStorageV1alpha1VolumeAttachment

Parameters

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function create_volume_attachment(body, options \\ []) View Source
create_volume_attachment(Kazan.Apis.Storage.V1alpha1.VolumeAttachment.t(), [
  {:pretty, String.t()}
]) :: {:ok, Kazan.Request.t()} | {:error, term()}

create a VolumeAttachment

OpenAPI Operation ID: createStorageV1alpha1VolumeAttachment

Parameters

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function delete_collection_volume_attachment!(options \\ []) View Source
delete_collection_volume_attachment!(
  pretty: String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: Kazan.Request.t()

delete collection of VolumeAttachment

OpenAPI Operation ID: deleteStorageV1alpha1CollectionVolumeAttachment

Options

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

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.Status

Link to this function delete_collection_volume_attachment(options \\ []) View Source
delete_collection_volume_attachment(
  pretty: String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

delete collection of VolumeAttachment

OpenAPI Operation ID: deleteStorageV1alpha1CollectionVolumeAttachment

Options

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

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.Status

Link to this function delete_volume_attachment!(body, name, options \\ []) View Source
delete_volume_attachment!(
  Kazan.Models.Apimachinery.Meta.V1.DeleteOptions.t(),
  String.t(),
  pretty: String.t(),
  grace_period_seconds: integer(),
  orphan_dependents: boolean(),
  propagation_policy: String.t()
) :: Kazan.Request.t()

delete a VolumeAttachment

OpenAPI Operation ID: deleteStorageV1alpha1VolumeAttachment

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

Response

See Kazan.Models.Apimachinery.Meta.V1.Status

Link to this function delete_volume_attachment(body, name, options \\ []) View Source
delete_volume_attachment(
  Kazan.Models.Apimachinery.Meta.V1.DeleteOptions.t(),
  String.t(),
  pretty: String.t(),
  grace_period_seconds: integer(),
  orphan_dependents: boolean(),
  propagation_policy: String.t()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

delete a VolumeAttachment

OpenAPI Operation ID: deleteStorageV1alpha1VolumeAttachment

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

Response

See Kazan.Models.Apimachinery.Meta.V1.Status

Link to this function get_api_resources!() View Source
get_api_resources!() :: Kazan.Request.t()

get available resources

OpenAPI Operation ID: getStorageV1alpha1APIResources

Response

See Kazan.Models.Apimachinery.Meta.V1.APIResourceList

Link to this function get_api_resources() View Source
get_api_resources() :: {:ok, Kazan.Request.t()} | {:error, term()}

get available resources

OpenAPI Operation ID: getStorageV1alpha1APIResources

Response

See Kazan.Models.Apimachinery.Meta.V1.APIResourceList

Link to this function list_volume_attachment!(options \\ []) View Source
list_volume_attachment!(
  pretty: String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: Kazan.Request.t()

list or watch objects of kind VolumeAttachment

OpenAPI Operation ID: listStorageV1alpha1VolumeAttachment

Options

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

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Apis.Storage.V1alpha1.VolumeAttachmentList

Link to this function list_volume_attachment(options \\ []) View Source
list_volume_attachment(
  pretty: String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

list or watch objects of kind VolumeAttachment

OpenAPI Operation ID: listStorageV1alpha1VolumeAttachment

Options

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

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Apis.Storage.V1alpha1.VolumeAttachmentList

Link to this function patch_volume_attachment!(body, name, options \\ []) View Source
patch_volume_attachment!(
  Kazan.Models.Apimachinery.Meta.V1.Patch.t(),
  String.t(),
  [{:pretty, String.t()}]
) :: Kazan.Request.t()

partially update the specified VolumeAttachment

OpenAPI Operation ID: patchStorageV1alpha1VolumeAttachment

Parameters

  • body - See Kazan.Models.Apimachinery.Meta.V1.Patch.
  • name - name of the VolumeAttachment

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function patch_volume_attachment(body, name, options \\ []) View Source
patch_volume_attachment(
  Kazan.Models.Apimachinery.Meta.V1.Patch.t(),
  String.t(),
  [{:pretty, String.t()}]
) :: {:ok, Kazan.Request.t()} | {:error, term()}

partially update the specified VolumeAttachment

OpenAPI Operation ID: patchStorageV1alpha1VolumeAttachment

Parameters

  • body - See Kazan.Models.Apimachinery.Meta.V1.Patch.
  • name - name of the VolumeAttachment

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function read_volume_attachment!(name, options \\ []) View Source
read_volume_attachment!(String.t(),
  pretty: String.t(),
  exact: boolean(),
  export: boolean()
) :: Kazan.Request.t()

read the specified VolumeAttachment

OpenAPI Operation ID: readStorageV1alpha1VolumeAttachment

Parameters

  • name - name of the VolumeAttachment

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.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function read_volume_attachment(name, options \\ []) View Source
read_volume_attachment(String.t(),
  pretty: String.t(),
  exact: boolean(),
  export: boolean()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

read the specified VolumeAttachment

OpenAPI Operation ID: readStorageV1alpha1VolumeAttachment

Parameters

  • name - name of the VolumeAttachment

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.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function replace_volume_attachment!(body, name, options \\ []) View Source
replace_volume_attachment!(
  Kazan.Apis.Storage.V1alpha1.VolumeAttachment.t(),
  String.t(),
  [{:pretty, String.t()}]
) :: Kazan.Request.t()

replace the specified VolumeAttachment

OpenAPI Operation ID: replaceStorageV1alpha1VolumeAttachment

Parameters

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function replace_volume_attachment(body, name, options \\ []) View Source
replace_volume_attachment(
  Kazan.Apis.Storage.V1alpha1.VolumeAttachment.t(),
  String.t(),
  [{:pretty, String.t()}]
) :: {:ok, Kazan.Request.t()} | {:error, term()}

replace the specified VolumeAttachment

OpenAPI Operation ID: replaceStorageV1alpha1VolumeAttachment

Parameters

Options

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

Response

See Kazan.Apis.Storage.V1alpha1.VolumeAttachment

Link to this function watch_volume_attachment!(name, options \\ []) View Source
watch_volume_attachment!(String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  pretty: String.t(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: Kazan.Request.t()

watch changes to an object of kind VolumeAttachment

OpenAPI Operation ID: watchStorageV1alpha1VolumeAttachment

Parameters

  • name - name of the VolumeAttachment

Options

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.WatchEvent

Link to this function watch_volume_attachment(name, options \\ []) View Source
watch_volume_attachment(String.t(),
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  pretty: String.t(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

watch changes to an object of kind VolumeAttachment

OpenAPI Operation ID: watchStorageV1alpha1VolumeAttachment

Parameters

  • name - name of the VolumeAttachment

Options

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.WatchEvent

Link to this function watch_volume_attachment_list!(options \\ []) View Source
watch_volume_attachment_list!(
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  pretty: String.t(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: Kazan.Request.t()

watch individual changes to a list of VolumeAttachment

OpenAPI Operation ID: watchStorageV1alpha1VolumeAttachmentList

Options

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.WatchEvent

Link to this function watch_volume_attachment_list(options \\ []) View Source
watch_volume_attachment_list(
  continue: String.t(),
  field_selector: String.t(),
  include_uninitialized: boolean(),
  label_selector: String.t(),
  limit: integer(),
  pretty: String.t(),
  resource_version: String.t(),
  timeout_seconds: integer(),
  watch: boolean()
) :: {:ok, Kazan.Request.t()} | {:error, term()}

watch individual changes to a list of VolumeAttachment

OpenAPI Operation ID: watchStorageV1alpha1VolumeAttachmentList

Options

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

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

  • include_uninitialized - If true, partially initialized resources are included in the response.

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

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

  • 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. This limits the duration of the call, regardless of any activity or inactivity.

  • 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.Meta.V1.WatchEvent