com.marcnuri.yakc.api.samplesoperatoropenshiftio.v1.SamplesOperatorOpenshiftIoV1Api Maven / Gradle / Ivy
Show all versions of openshift 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.samplesoperatoropenshiftio.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.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.openshift.operator.samples.v1.Config;
import com.marcnuri.yakc.model.io.openshift.operator.samples.v1.ConfigList;
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 SamplesOperatorOpenshiftIoV1Api extends Api {
/**
* delete collection of Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs"
)
@Headers({
"Accept: */*"
})
KubernetesCall deleteCollectionConfig();
/**
* delete collection of Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs"
)
@Headers({
"Accept: */*"
})
KubernetesCall deleteCollectionConfig(
@QueryMap DeleteCollectionConfig queryParameters);
final class DeleteCollectionConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public DeleteCollectionConfig 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 DeleteCollectionConfig 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 DeleteCollectionConfig continues(String continues) {
put("continue", continues);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public DeleteCollectionConfig fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public DeleteCollectionConfig 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 DeleteCollectionConfig limit(Number 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 DeleteCollectionConfig 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 DeleteCollectionConfig timeoutSeconds(Number 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 DeleteCollectionConfig watch(Boolean watch) {
put("watch", watch);
return this;
}
}
/**
* list objects of kind Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs"
)
@Headers({
"Accept: */*"
})
KubernetesListCall listConfig();
/**
* list objects of kind Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs"
)
@Headers({
"Accept: */*"
})
KubernetesListCall listConfig(
@QueryMap ListConfig queryParameters);
final class ListConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ListConfig 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 ListConfig 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 ListConfig continues(String continues) {
put("continue", continues);
return this;
}
/**
* A selector to restrict the list of returned objects by their fields. Defaults to everything.
*/
public ListConfig fieldSelector(String fieldSelector) {
put("fieldSelector", fieldSelector);
return this;
}
/**
* A selector to restrict the list of returned objects by their labels. Defaults to everything.
*/
public ListConfig 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 ListConfig limit(Number 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 ListConfig 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 ListConfig timeoutSeconds(Number 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 ListConfig watch(Boolean watch) {
put("watch", watch);
return this;
}
}
/**
* create a Config
*/
@HTTP(
method = "POST",
path = "/apis/samples.operator.openshift.io/v1/configs",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall createConfig(
@Body Config body);
/**
* create a Config
*/
@HTTP(
method = "POST",
path = "/apis/samples.operator.openshift.io/v1/configs",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall createConfig(
@Body Config body,
@QueryMap CreateConfig queryParameters);
final class CreateConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public CreateConfig 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 CreateConfig 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 CreateConfig fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* delete a Config
*
* @param name name of the Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteConfig(
@Path("name") String name,
@Body DeleteOptions body);
/**
* delete a Config
*
* @param name name of the Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteConfig(
@Path("name") String name);
/**
* delete a Config
*
* @param name name of the Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteConfig(
@Path("name") String name,
@Body DeleteOptions body,
@QueryMap DeleteConfig queryParameters);
/**
* delete a Config
*
* @param name name of the Config
*/
@HTTP(
method = "DELETE",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall deleteConfig(
@Path("name") String name,
@QueryMap DeleteConfig queryParameters);
final class DeleteConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public DeleteConfig 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 DeleteConfig 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 DeleteConfig gracePeriodSeconds(Number 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 DeleteConfig 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 DeleteConfig propagationPolicy(String propagationPolicy) {
put("propagationPolicy", propagationPolicy);
return this;
}
}
/**
* read the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall readConfig(
@Path("name") String name);
/**
* read the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}"
)
@Headers({
"Accept: */*"
})
KubernetesCall readConfig(
@Path("name") String name,
@QueryMap ReadConfig queryParameters);
final class ReadConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReadConfig pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* When specified: - 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 ReadConfig resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
}
/**
* partially update the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PATCH",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchConfig(
@Path("name") String name,
@Body Config body);
/**
* partially update the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PATCH",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchConfig(
@Path("name") String name,
@Body Config body,
@QueryMap PatchConfig queryParameters);
final class PatchConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public PatchConfig 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 PatchConfig 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 PatchConfig fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* replace the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PUT",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceConfig(
@Path("name") String name,
@Body Config body);
/**
* replace the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PUT",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceConfig(
@Path("name") String name,
@Body Config body,
@QueryMap ReplaceConfig queryParameters);
final class ReplaceConfig extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReplaceConfig 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 ReplaceConfig 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 ReplaceConfig fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* read status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status"
)
@Headers({
"Accept: */*"
})
KubernetesCall readConfigStatus(
@Path("name") String name);
/**
* read status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "GET",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status"
)
@Headers({
"Accept: */*"
})
KubernetesCall readConfigStatus(
@Path("name") String name,
@QueryMap ReadConfigStatus queryParameters);
final class ReadConfigStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReadConfigStatus pretty(String pretty) {
put("pretty", pretty);
return this;
}
/**
* When specified: - 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 ReadConfigStatus resourceVersion(String resourceVersion) {
put("resourceVersion", resourceVersion);
return this;
}
}
/**
* partially update status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PATCH",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchConfigStatus(
@Path("name") String name,
@Body Config body);
/**
* partially update status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PATCH",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/merge-patch+json",
"Accept: */*"
})
KubernetesCall patchConfigStatus(
@Path("name") String name,
@Body Config body,
@QueryMap PatchConfigStatus queryParameters);
final class PatchConfigStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public PatchConfigStatus 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 PatchConfigStatus 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 PatchConfigStatus fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
/**
* replace status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PUT",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceConfigStatus(
@Path("name") String name,
@Body Config body);
/**
* replace status of the specified Config
*
* @param name name of the Config
*/
@HTTP(
method = "PUT",
path = "/apis/samples.operator.openshift.io/v1/configs/{name}/status",
hasBody = true
)
@Headers({
"Content-Type: application/json",
"Accept: */*"
})
KubernetesCall replaceConfigStatus(
@Path("name") String name,
@Body Config body,
@QueryMap ReplaceConfigStatus queryParameters);
final class ReplaceConfigStatus extends HashMap {
/**
* If 'true', then the output is pretty printed.
*/
public ReplaceConfigStatus 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 ReplaceConfigStatus 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 ReplaceConfigStatus fieldManager(String fieldManager) {
put("fieldManager", fieldManager);
return this;
}
}
}