Package io.kubernetes.client.openapi.apis

Class CustomObjectsApi.APIlistNamespacedCustomObjectRequest

java.lang.Object
io.kubernetes.client.openapi.apis.CustomObjectsApi.APIlistNamespacedCustomObjectRequest
Enclosing class:
CustomObjectsApi
public class CustomObjectsApi.APIlistNamespacedCustomObjectRequest extends Object

  • Method Details

    • pretty

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest pretty(String pretty)
      Set pretty
      Parameters:
      pretty - If 'true', then the output is pretty printed. (optional)
      Returns:
      APIlistNamespacedCustomObjectRequest

    • allowWatchBookmarks

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest allowWatchBookmarks(Boolean allowWatchBookmarks)
      Set allowWatchBookmarks
      Parameters:
      allowWatchBookmarks - allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. (optional)
      Returns:
      APIlistNamespacedCustomObjectRequest

    • _continue

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest _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:
      APIlistNamespacedCustomObjectRequest

    • fieldSelector

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

    • labelSelector

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

    • limit

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest 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:
      APIlistNamespacedCustomObjectRequest

    • resourceVersion

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest resourceVersion(String resourceVersion)
      Set resourceVersion
      Parameters:
      resourceVersion - 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. (optional)
      Returns:
      APIlistNamespacedCustomObjectRequest

    • resourceVersionMatch

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest 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:
      APIlistNamespacedCustomObjectRequest

    • timeoutSeconds

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest 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:
      APIlistNamespacedCustomObjectRequest

    • watch

      public CustomObjectsApi.APIlistNamespacedCustomObjectRequest watch(Boolean watch)
      Set watch
      Parameters:
      watch - Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional)
      Returns:
      APIlistNamespacedCustomObjectRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for listNamespacedCustomObject
      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 Object execute() throws ApiException
      Execute listNamespacedCustomObject request
      Returns:
      Object
      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<Object> executeWithHttpInfo() throws ApiException
      Execute listNamespacedCustomObject request with HTTP info returned
      Returns:
      ApiResponse<Object>
      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<Object> _callback) throws ApiException
      Execute listNamespacedCustomObject 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 -