Package io.kubernetes.client.openapi.apis

Class BatchV1Api.APIdeleteCollectionNamespacedJobRequest

java.lang.Object
io.kubernetes.client.openapi.apis.BatchV1Api.APIdeleteCollectionNamespacedJobRequest
Enclosing class:
BatchV1Api
public class BatchV1Api.APIdeleteCollectionNamespacedJobRequest extends Object

  • Method Details

    • pretty

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest pretty(String pretty)
      Set pretty
      Parameters:
      pretty - If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • _continue

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest _continue(String _continue)
      Set _continue
      Parameters:
      _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 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. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • dryRun

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest dryRun(String dryRun)
      Set dryRun
      Parameters:
      dryRun - 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 (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • fieldSelector

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest fieldSelector(String fieldSelector)
      Set fieldSelector
      Parameters:
      fieldSelector - A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • gracePeriodSeconds

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest gracePeriodSeconds(Integer gracePeriodSeconds)
      Set gracePeriodSeconds
      Parameters:
      gracePeriodSeconds - 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. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • labelSelector

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest labelSelector(String labelSelector)
      Set labelSelector
      Parameters:
      labelSelector - A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • limit

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest limit(Integer limit)
      Set limit
      Parameters:
      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. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • orphanDependents

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest orphanDependents(Boolean orphanDependents)
      Set orphanDependents
      Parameters:
      orphanDependents - 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. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • propagationPolicy

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest propagationPolicy(String propagationPolicy)
      Set propagationPolicy
      Parameters:
      propagationPolicy - 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. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • resourceVersion

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest resourceVersion(String resourceVersion)
      Set resourceVersion
      Parameters:
      resourceVersion - resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • resourceVersionMatch

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest resourceVersionMatch(String resourceVersionMatch)
      Set resourceVersionMatch
      Parameters:
      resourceVersionMatch - resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • sendInitialEvents

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest sendInitialEvents(Boolean sendInitialEvents)
      Set sendInitialEvents
      Parameters:
      sendInitialEvents - `sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan is interpreted as \"data at least as new as the provided `resourceVersion`\" and the bookmark event is send when the state is synced to a `resourceVersion` at least as fresh as the one provided by the ListOptions. If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - `resourceVersionMatch` set to any other value or unset Invalid error is returned. Defaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • timeoutSeconds

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest timeoutSeconds(Integer timeoutSeconds)
      Set timeoutSeconds
      Parameters:
      timeoutSeconds - Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • body

      public BatchV1Api.APIdeleteCollectionNamespacedJobRequest body(V1DeleteOptions body)
      Set body
      Parameters:
      body - (optional)
      Returns:
      APIdeleteCollectionNamespacedJobRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for deleteCollectionNamespacedJob
      Parameters:
      _callback - ApiCallback API callback
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • execute

      public V1Status execute() throws ApiException
      Execute deleteCollectionNamespacedJob request
      Returns:
      V1Status
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • executeWithHttpInfo

      public ApiResponse<V1Status> executeWithHttpInfo() throws ApiException
      Execute deleteCollectionNamespacedJob request with HTTP info returned
      Returns:
      ApiResponse<V1Status>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -

    • executeAsync

      public okhttp3.Call executeAsync(ApiCallback<V1Status> _callback) throws ApiException
      Execute deleteCollectionNamespacedJob request (asynchronously)
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 OK -
      401 Unauthorized -