Interface CustomObjectsApiWatcher
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen")
@Client("kubernetes-client")
public interface CustomObjectsApiWatcher
-
Method Summary
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Object>listClusterCustomObject(@NotNull String group, @NotNull String version, @NotNull String plural, @Nullable String pretty, @Nullable Boolean allowWatchBookmarks, @Nullable String _continue, @Nullable String fieldSelector, @Nullable String labelSelector, @Nullable Integer limit, @Nullable String resourceVersion, @Nullable String resourceVersionMatch, @Nullable Integer timeoutSeconds, @Nullable Boolean watch) list or watch cluster scoped custom objectsreactor.core.publisher.Mono<Object>listNamespacedCustomObject(@NotNull String group, @NotNull String version, @NotNull String namespace, @NotNull String plural, @Nullable String pretty, @Nullable Boolean allowWatchBookmarks, @Nullable String _continue, @Nullable String fieldSelector, @Nullable String labelSelector, @Nullable Integer limit, @Nullable String resourceVersion, @Nullable String resourceVersionMatch, @Nullable Integer timeoutSeconds, @Nullable Boolean watch) list or watch namespace scoped custom objects
-
Method Details
-
listClusterCustomObject
@Get("/apis/{group}/{version}/{plural}") @Consumes({"application/json","application/json;stream=watch"}) reactor.core.publisher.Mono<Object> listClusterCustomObject(@PathVariable("group") @NotNull @NotNull String group, @PathVariable("version") @NotNull @NotNull String version, @PathVariable("plural") @NotNull @NotNull String plural, @QueryValue("pretty") @Nullable @Nullable String pretty, @QueryValue("allowWatchBookmarks") @Nullable @Nullable Boolean allowWatchBookmarks, @QueryValue("continue") @Nullable @Nullable String _continue, @QueryValue("fieldSelector") @Nullable @Nullable String fieldSelector, @QueryValue("labelSelector") @Nullable @Nullable String labelSelector, @QueryValue("limit") @Nullable @Nullable Integer limit, @QueryValue("resourceVersion") @Nullable @Nullable String resourceVersion, @QueryValue("resourceVersionMatch") @Nullable @Nullable String resourceVersionMatch, @QueryValue("timeoutSeconds") @Nullable @Nullable Integer timeoutSeconds, @QueryValue("watch") @Nullable @Nullable Boolean watch) list or watch cluster scoped custom objects- Parameters:
group- The custom resource's group name (required)version- The custom resource's version (required)plural- The custom resource's plural name. For TPRs this would be lowercase plural kind. (required)pretty- If 'true', then the output is pretty printed. (optional)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)_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)fieldSelector- A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)labelSelector- A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)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)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)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)timeoutSeconds- Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)watch- Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional)- Returns:
- OK (status code 200) or Unauthorized (status code 401)
-
listNamespacedCustomObject
@Get("/apis/{group}/{version}/namespaces/{namespace}/{plural}") @Consumes({"application/json","application/json;stream=watch"}) reactor.core.publisher.Mono<Object> listNamespacedCustomObject(@PathVariable("group") @NotNull @NotNull String group, @PathVariable("version") @NotNull @NotNull String version, @PathVariable("namespace") @NotNull @NotNull String namespace, @PathVariable("plural") @NotNull @NotNull String plural, @QueryValue("pretty") @Nullable @Nullable String pretty, @QueryValue("allowWatchBookmarks") @Nullable @Nullable Boolean allowWatchBookmarks, @QueryValue("continue") @Nullable @Nullable String _continue, @QueryValue("fieldSelector") @Nullable @Nullable String fieldSelector, @QueryValue("labelSelector") @Nullable @Nullable String labelSelector, @QueryValue("limit") @Nullable @Nullable Integer limit, @QueryValue("resourceVersion") @Nullable @Nullable String resourceVersion, @QueryValue("resourceVersionMatch") @Nullable @Nullable String resourceVersionMatch, @QueryValue("timeoutSeconds") @Nullable @Nullable Integer timeoutSeconds, @QueryValue("watch") @Nullable @Nullable Boolean watch) list or watch namespace scoped custom objects- Parameters:
group- The custom resource's group name (required)version- The custom resource's version (required)namespace- The custom resource's namespace (required)plural- The custom resource's plural name. For TPRs this would be lowercase plural kind. (required)pretty- If 'true', then the output is pretty printed. (optional)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)_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)fieldSelector- A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)labelSelector- A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)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)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)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)timeoutSeconds- Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)watch- Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. (optional)- Returns:
- OK (status code 200) or Unauthorized (status code 401)
-