com.marcnuri.yakc.api.apiextensions.v1.ApiextensionsV1Api Maven / Gradle / Ivy
Show all versions of kubernetes-api Show documentation
/*
* Copyright 2020 Marc Nuri
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.marcnuri.yakc.api.apiextensions.v1;
import com.marcnuri.yakc.api.Api;
import com.marcnuri.yakc.api.KubernetesCall;
import com.marcnuri.yakc.api.KubernetesListCall;
import com.marcnuri.yakc.model.io.k8s.apiextensionsapiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition;
import com.marcnuri.yakc.model.io.k8s.apiextensionsapiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList;
import com.marcnuri.yakc.model.io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList;
import com.marcnuri.yakc.model.io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions;
import com.marcnuri.yakc.model.io.k8s.apimachinery.pkg.apis.meta.v1.Status;
import com.marcnuri.yakc.model.io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent;
import java.util.HashMap;
import retrofit2.http.Body;
import retrofit2.http.HTTP;
import retrofit2.http.Headers;
import retrofit2.http.Path;
import retrofit2.http.QueryMap;
@SuppressWarnings({"squid:S1192", "unused"})
public interface ApiextensionsV1Api extends Api {
/**
* get available resources
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/"
)
@Headers({
"Accept: */*"
})
KubernetesCall getAPIResources();
/**
* delete collection of CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCollectionCustomResourceDefinition(
@Body DeleteOptions body);
/**
* delete collection of CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCollectionCustomResourceDefinition();
/**
* delete collection of CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCollectionCustomResourceDefinition(
@Body DeleteOptions body,
@QueryMap DeleteCollectionCustomResourceDefinition queryParameters);
/**
* delete collection of CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCollectionCustomResourceDefinition(
@QueryMap DeleteCollectionCustomResourceDefinition queryParameters);
final class DeleteCollectionCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public DeleteCollectionCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition allowWatchBookmarks(Boolean allowWatchBookmarks) {
put("allowWatchBookmarks", allowWatchBookmarks);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition continues(String continues) {
put("continue", continues);
return this;
}
/**
* 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
*/
public DeleteCollectionCustomResourceDefinition dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public DeleteCollectionCustomResourceDefinition fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition gracePeriodSeconds(Integer gracePeriodSeconds) {
put("gracePeriodSeconds", gracePeriodSeconds);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public DeleteCollectionCustomResourceDefinition labelSelector(String labelSelector) {
put("labelSelector", labelSelector);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition limit(Integer limit) {
put("limit", limit);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition orphanDependents(Boolean orphanDependents) {
put("orphanDependents", orphanDependents);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition propagationPolicy(String propagationPolicy) {
put("propagationPolicy", propagationPolicy);
return this;
}
/**
* 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.
*/
public DeleteCollectionCustomResourceDefinition resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
/**
* Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
*/
public DeleteCollectionCustomResourceDefinition timeoutSeconds(Integer timeoutSeconds) {
put("timeoutSeconds", timeoutSeconds);
return this;
}
/**
* Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
*/
public DeleteCollectionCustomResourceDefinition watch(Boolean watch) {
put("watch", watch);
return this;
}
}
/**
* list or watch objects of kind CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"
)
@Headers({
"Accept: */*"
})
KubernetesListCall listCustomResourceDefinition();
/**
* list or watch objects of kind CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"
)
@Headers({
"Accept: */*"
})
KubernetesListCall listCustomResourceDefinition(
@QueryMap ListCustomResourceDefinition queryParameters);
final class ListCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ListCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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.
*/
public ListCustomResourceDefinition allowWatchBookmarks(Boolean allowWatchBookmarks) {
put("allowWatchBookmarks", allowWatchBookmarks);
return this;
}
/**
* 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.
*/
public ListCustomResourceDefinition continues(String continues) {
put("continue", continues);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public ListCustomResourceDefinition fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public ListCustomResourceDefinition labelSelector(String labelSelector) {
put("labelSelector", labelSelector);
return this;
}
/**
* 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.
*/
public ListCustomResourceDefinition limit(Integer limit) {
put("limit", limit);
return this;
}
/**
* 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.
*/
public ListCustomResourceDefinition resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
/**
* Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
*/
public ListCustomResourceDefinition timeoutSeconds(Integer timeoutSeconds) {
put("timeoutSeconds", timeoutSeconds);
return this;
}
/**
* Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
*/
public ListCustomResourceDefinition watch(Boolean watch) {
put("watch", watch);
return this;
}
}
/**
* create a CustomResourceDefinition
*/
@HTTP(
method = "POST",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall createCustomResourceDefinition(
@Body CustomResourceDefinition body);
/**
* create a CustomResourceDefinition
*/
@HTTP(
method = "POST",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall createCustomResourceDefinition(
@Body CustomResourceDefinition body,
@QueryMap CreateCustomResourceDefinition queryParameters);
final class CreateCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public CreateCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public CreateCustomResourceDefinition dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
*/
public CreateCustomResourceDefinition fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* delete a CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCustomResourceDefinition(
@Path("name") String name,
@Body DeleteOptions body);
/**
* delete a CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCustomResourceDefinition(
@Path("name") String name);
/**
* delete a CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCustomResourceDefinition(
@Path("name") String name,
@Body DeleteOptions body,
@QueryMap DeleteCustomResourceDefinition queryParameters);
/**
* delete a CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "DELETE",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteCustomResourceDefinition(
@Path("name") String name,
@QueryMap DeleteCustomResourceDefinition queryParameters);
final class DeleteCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public DeleteCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public DeleteCustomResourceDefinition dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* 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.
*/
public DeleteCustomResourceDefinition gracePeriodSeconds(Integer gracePeriodSeconds) {
put("gracePeriodSeconds", gracePeriodSeconds);
return this;
}
/**
* 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.
*/
public DeleteCustomResourceDefinition orphanDependents(Boolean orphanDependents) {
put("orphanDependents", orphanDependents);
return this;
}
/**
* 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.
*/
public DeleteCustomResourceDefinition propagationPolicy(String propagationPolicy) {
put("propagationPolicy", propagationPolicy);
return this;
}
}
/**
* read the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall readCustomResourceDefinition(
@Path("name") String name);
/**
* read the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall readCustomResourceDefinition(
@Path("name") String name,
@QueryMap ReadCustomResourceDefinition queryParameters);
final class ReadCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReadCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18.
*/
public ReadCustomResourceDefinition exact(Boolean exact) {
put("exact", exact);
return this;
}
/**
* Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18.
*/
public ReadCustomResourceDefinition export(Boolean export) {
put("export", export);
return this;
}
}
/**
* partially update the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PATCH",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchCustomResourceDefinition(
@Path("name") String name,
@Body CustomResourceDefinition body);
/**
* partially update the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PATCH",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchCustomResourceDefinition(
@Path("name") String name,
@Body CustomResourceDefinition body,
@QueryMap PatchCustomResourceDefinition queryParameters);
final class PatchCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public PatchCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public PatchCustomResourceDefinition dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
*/
public PatchCustomResourceDefinition fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
/**
* Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
*/
public PatchCustomResourceDefinition force(Boolean force) {
put("force", force);
return this;
}
}
/**
* replace the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PUT",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceCustomResourceDefinition(
@Path("name") String name,
@Body CustomResourceDefinition body);
/**
* replace the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PUT",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceCustomResourceDefinition(
@Path("name") String name,
@Body CustomResourceDefinition body,
@QueryMap ReplaceCustomResourceDefinition queryParameters);
final class ReplaceCustomResourceDefinition extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReplaceCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public ReplaceCustomResourceDefinition dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
*/
public ReplaceCustomResourceDefinition fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* read status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status"
)
@Headers({
"Accept: */*"
})
KubernetesCall readCustomResourceDefinitionStatus(
@Path("name") String name);
/**
* read status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status"
)
@Headers({
"Accept: */*"
})
KubernetesCall readCustomResourceDefinitionStatus(
@Path("name") String name,
@QueryMap ReadCustomResourceDefinitionStatus queryParameters);
final class ReadCustomResourceDefinitionStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReadCustomResourceDefinitionStatus pretty(String pretty) {
put("pretty", pretty);
return this;
}
}
/**
* partially update status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PATCH",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchCustomResourceDefinitionStatus(
@Path("name") String name,
@Body CustomResourceDefinition body);
/**
* partially update status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PATCH",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchCustomResourceDefinitionStatus(
@Path("name") String name,
@Body CustomResourceDefinition body,
@QueryMap PatchCustomResourceDefinitionStatus queryParameters);
final class PatchCustomResourceDefinitionStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public PatchCustomResourceDefinitionStatus pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public PatchCustomResourceDefinitionStatus dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
*/
public PatchCustomResourceDefinitionStatus fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
/**
* Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
*/
public PatchCustomResourceDefinitionStatus force(Boolean force) {
put("force", force);
return this;
}
}
/**
* replace status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PUT",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceCustomResourceDefinitionStatus(
@Path("name") String name,
@Body CustomResourceDefinition body);
/**
* replace status of the specified CustomResourceDefinition
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "PUT",
path = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceCustomResourceDefinitionStatus(
@Path("name") String name,
@Body CustomResourceDefinition body,
@QueryMap ReplaceCustomResourceDefinitionStatus queryParameters);
final class ReplaceCustomResourceDefinitionStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReplaceCustomResourceDefinitionStatus pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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
*/
public ReplaceCustomResourceDefinitionStatus dryRun(String dryRun) {
put("dryRun", dryRun);
return this;
}
/**
* fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
*/
public ReplaceCustomResourceDefinitionStatus fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions"
)
@Headers({
"Accept: */*"
})
KubernetesCall watchCustomResourceDefinitionList();
/**
* watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions"
)
@Headers({
"Accept: */*"
})
KubernetesCall watchCustomResourceDefinitionList(
@QueryMap WatchCustomResourceDefinitionList queryParameters);
final class WatchCustomResourceDefinitionList extends HashMap {
/**
* 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.
*/
public WatchCustomResourceDefinitionList allowWatchBookmarks(Boolean allowWatchBookmarks) {
put("allowWatchBookmarks", allowWatchBookmarks);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinitionList continues(String continues) {
put("continue", continues);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public WatchCustomResourceDefinitionList fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public WatchCustomResourceDefinitionList labelSelector(String labelSelector) {
put("labelSelector", labelSelector);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinitionList limit(Integer limit) {
put("limit", limit);
return this;
}
/**
* If 'true', then the output is pretty printed.
*/
public WatchCustomResourceDefinitionList pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinitionList resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
/**
* Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
*/
public WatchCustomResourceDefinitionList timeoutSeconds(Integer timeoutSeconds) {
put("timeoutSeconds", timeoutSeconds);
return this;
}
/**
* Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
*/
public WatchCustomResourceDefinitionList watch(Boolean watch) {
put("watch", watch);
return this;
}
}
/**
* watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall watchCustomResourceDefinition(
@Path("name") String name);
/**
* watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
*
* @param name name of the CustomResourceDefinition
*/
@HTTP(
method = "GET",
path = "/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall watchCustomResourceDefinition(
@Path("name") String name,
@QueryMap WatchCustomResourceDefinition queryParameters);
final class WatchCustomResourceDefinition extends HashMap {
/**
* 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.
*/
public WatchCustomResourceDefinition allowWatchBookmarks(Boolean allowWatchBookmarks) {
put("allowWatchBookmarks", allowWatchBookmarks);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinition continues(String continues) {
put("continue", continues);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public WatchCustomResourceDefinition fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public WatchCustomResourceDefinition labelSelector(String labelSelector) {
put("labelSelector", labelSelector);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinition limit(Integer limit) {
put("limit", limit);
return this;
}
/**
* If 'true', then the output is pretty printed.
*/
public WatchCustomResourceDefinition pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* 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.
*/
public WatchCustomResourceDefinition resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
/**
* Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
*/
public WatchCustomResourceDefinition timeoutSeconds(Integer timeoutSeconds) {
put("timeoutSeconds", timeoutSeconds);
return this;
}
/**
* Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
*/
public WatchCustomResourceDefinition watch(Boolean watch) {
put("watch", watch);
return this;
}
}
}