KubedbComV1alpha1Api

June 20, 2018 ยท View on GitHub

All URIs are relative to https://localhost

MethodHTTP requestDescription
createNamespacedDormantDatabasePOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
createNamespacedElasticsearchPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
createNamespacedMemcachedPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
createNamespacedMongoDBPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
createNamespacedMySQLPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
createNamespacedPostgresPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
createNamespacedRedisPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
createNamespacedSnapshotPOST /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
deleteCollectionNamespacedDormantDatabaseDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
deleteCollectionNamespacedElasticsearchDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
deleteCollectionNamespacedMemcachedDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
deleteCollectionNamespacedMongoDBDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
deleteCollectionNamespacedMySQLDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
deleteCollectionNamespacedPostgresDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
deleteCollectionNamespacedRedisDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
deleteCollectionNamespacedSnapshotDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
deleteNamespacedDormantDatabaseDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
deleteNamespacedElasticsearchDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
deleteNamespacedMemcachedDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
deleteNamespacedMongoDBDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
deleteNamespacedMySQLDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
deleteNamespacedPostgresDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
deleteNamespacedRedisDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
deleteNamespacedSnapshotDELETE /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
getAPIResourcesGET /apis/kubedb.com/v1alpha1/
listDormantDatabaseForAllNamespacesGET /apis/kubedb.com/v1alpha1/dormantdatabases
listElasticsearchForAllNamespacesGET /apis/kubedb.com/v1alpha1/elasticsearches
listMemcachedForAllNamespacesGET /apis/kubedb.com/v1alpha1/memcacheds
listMongoDBForAllNamespacesGET /apis/kubedb.com/v1alpha1/mongodbs
listMySQLForAllNamespacesGET /apis/kubedb.com/v1alpha1/mysqls
listNamespacedDormantDatabaseGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases
listNamespacedElasticsearchGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches
listNamespacedMemcachedGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds
listNamespacedMongoDBGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs
listNamespacedMySQLGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls
listNamespacedPostgresGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses
listNamespacedRedisGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises
listNamespacedSnapshotGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots
listPostgresForAllNamespacesGET /apis/kubedb.com/v1alpha1/postgreses
listRedisForAllNamespacesGET /apis/kubedb.com/v1alpha1/redises
listSnapshotForAllNamespacesGET /apis/kubedb.com/v1alpha1/snapshots
patchNamespacedDormantDatabasePATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
patchNamespacedElasticsearchPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
patchNamespacedMemcachedPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
patchNamespacedMongoDBPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
patchNamespacedMySQLPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
patchNamespacedPostgresPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
patchNamespacedRedisPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
patchNamespacedSnapshotPATCH /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
readNamespacedDormantDatabaseGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
readNamespacedElasticsearchGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
readNamespacedMemcachedGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
readNamespacedMongoDBGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
readNamespacedMySQLGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
readNamespacedPostgresGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
readNamespacedRedisGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
readNamespacedSnapshotGET /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}
replaceNamespacedDormantDatabasePUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/dormantdatabases/{name}
replaceNamespacedElasticsearchPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/elasticsearches/{name}
replaceNamespacedMemcachedPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/memcacheds/{name}
replaceNamespacedMongoDBPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mongodbs/{name}
replaceNamespacedMySQLPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/mysqls/{name}
replaceNamespacedPostgresPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/postgreses/{name}
replaceNamespacedRedisPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/redises/{name}
replaceNamespacedSnapshotPUT /apis/kubedb.com/v1alpha1/namespaces/{namespace}/snapshots/{name}

createNamespacedDormantDatabase

V1alpha1DormantDatabase createNamespacedDormantDatabase(namespace, body, pretty)

create a DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1DormantDatabase body = new V1alpha1DormantDatabase(); // V1alpha1DormantDatabase | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1DormantDatabase result = apiInstance.createNamespacedDormantDatabase(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1DormantDatabase
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1DormantDatabase

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedElasticsearch

V1alpha1Elasticsearch createNamespacedElasticsearch(namespace, body, pretty)

create an Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Elasticsearch body = new V1alpha1Elasticsearch(); // V1alpha1Elasticsearch | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Elasticsearch result = apiInstance.createNamespacedElasticsearch(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Elasticsearch
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Elasticsearch

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedMemcached

V1alpha1Memcached createNamespacedMemcached(namespace, body, pretty)

create a Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Memcached body = new V1alpha1Memcached(); // V1alpha1Memcached | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Memcached result = apiInstance.createNamespacedMemcached(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Memcached
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Memcached

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedMongoDB

V1alpha1MongoDB createNamespacedMongoDB(namespace, body, pretty)

create a MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1MongoDB body = new V1alpha1MongoDB(); // V1alpha1MongoDB | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MongoDB result = apiInstance.createNamespacedMongoDB(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1MongoDB
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MongoDB

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedMySQL

V1alpha1MySQL createNamespacedMySQL(namespace, body, pretty)

create a MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1MySQL body = new V1alpha1MySQL(); // V1alpha1MySQL | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MySQL result = apiInstance.createNamespacedMySQL(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1MySQL
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MySQL

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedPostgres

V1alpha1Postgres createNamespacedPostgres(namespace, body, pretty)

create Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Postgres body = new V1alpha1Postgres(); // V1alpha1Postgres | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Postgres result = apiInstance.createNamespacedPostgres(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Postgres
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Postgres

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedRedis

V1alpha1Redis createNamespacedRedis(namespace, body, pretty)

create Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Redis body = new V1alpha1Redis(); // V1alpha1Redis | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Redis result = apiInstance.createNamespacedRedis(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Redis
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Redis

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

createNamespacedSnapshot

V1alpha1Snapshot createNamespacedSnapshot(namespace, body, pretty)

create a Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Snapshot body = new V1alpha1Snapshot(); // V1alpha1Snapshot | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Snapshot result = apiInstance.createNamespacedSnapshot(namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#createNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Snapshot
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Snapshot

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedDormantDatabase

V1Status deleteCollectionNamespacedDormantDatabase(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedDormantDatabase(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedElasticsearch

V1Status deleteCollectionNamespacedElasticsearch(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedElasticsearch(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedMemcached

V1Status deleteCollectionNamespacedMemcached(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedMemcached(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedMongoDB

V1Status deleteCollectionNamespacedMongoDB(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedMongoDB(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedMySQL

V1Status deleteCollectionNamespacedMySQL(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedMySQL(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedPostgres

V1Status deleteCollectionNamespacedPostgres(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedPostgres(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedRedis

V1Status deleteCollectionNamespacedRedis(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedRedis(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteCollectionNamespacedSnapshot

V1Status deleteCollectionNamespacedSnapshot(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

delete collection of Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1Status result = apiInstance.deleteCollectionNamespacedSnapshot(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteCollectionNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedDormantDatabase

V1Status deleteNamespacedDormantDatabase(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete a DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the DormantDatabase
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedDormantDatabase(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the DormantDatabase
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedElasticsearch

V1Status deleteNamespacedElasticsearch(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete an Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Elasticsearch
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedElasticsearch(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Elasticsearch
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedMemcached

V1Status deleteNamespacedMemcached(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete a Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Memcached
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedMemcached(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Memcached
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedMongoDB

V1Status deleteNamespacedMongoDB(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete a MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MongoDB
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedMongoDB(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MongoDB
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedMySQL

V1Status deleteNamespacedMySQL(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete a MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MySQL
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedMySQL(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MySQL
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedPostgres

V1Status deleteNamespacedPostgres(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Postgres
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedPostgres(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Postgres
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedRedis

V1Status deleteNamespacedRedis(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Redis
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedRedis(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Redis
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

deleteNamespacedSnapshot

V1Status deleteNamespacedSnapshot(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy)

delete a Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Snapshot
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1DeleteOptions body = new V1DeleteOptions(); // V1DeleteOptions | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
Integer gracePeriodSeconds = 56; // Integer | 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.
Boolean orphanDependents = true; // Boolean | 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.
String propagationPolicy = "propagationPolicy_example"; // String | 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.
try {
    V1Status result = apiInstance.deleteNamespacedSnapshot(name, namespace, body, pretty, gracePeriodSeconds, orphanDependents, propagationPolicy);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#deleteNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Snapshot
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1DeleteOptions
prettyStringIf 'true', then the output is pretty printed.[optional]
gracePeriodSecondsIntegerThe 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]
orphanDependentsBooleanDeprecated: 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]
propagationPolicyStringWhether 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]

Return type

V1Status

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

getAPIResources

V1APIResourceList getAPIResources()

get available resources

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
try {
    V1APIResourceList result = apiInstance.getAPIResources();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#getAPIResources");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

V1APIResourceList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/yaml, application/vnd.kubernetes.protobuf
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

listDormantDatabaseForAllNamespaces

V1alpha1DormantDatabaseList listDormantDatabaseForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1DormantDatabaseList result = apiInstance.listDormantDatabaseForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listDormantDatabaseForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1DormantDatabaseList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listElasticsearchForAllNamespaces

V1alpha1ElasticsearchList listElasticsearchForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1ElasticsearchList result = apiInstance.listElasticsearchForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listElasticsearchForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1ElasticsearchList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listMemcachedForAllNamespaces

V1alpha1MemcachedList listMemcachedForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MemcachedList result = apiInstance.listMemcachedForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listMemcachedForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MemcachedList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listMongoDBForAllNamespaces

V1alpha1MongoDBList listMongoDBForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MongoDBList result = apiInstance.listMongoDBForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listMongoDBForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MongoDBList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listMySQLForAllNamespaces

V1alpha1MySQLList listMySQLForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MySQLList result = apiInstance.listMySQLForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listMySQLForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MySQLList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedDormantDatabase

V1alpha1DormantDatabaseList listNamespacedDormantDatabase(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1DormantDatabaseList result = apiInstance.listNamespacedDormantDatabase(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1DormantDatabaseList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedElasticsearch

V1alpha1ElasticsearchList listNamespacedElasticsearch(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1ElasticsearchList result = apiInstance.listNamespacedElasticsearch(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1ElasticsearchList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedMemcached

V1alpha1MemcachedList listNamespacedMemcached(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MemcachedList result = apiInstance.listNamespacedMemcached(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MemcachedList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedMongoDB

V1alpha1MongoDBList listNamespacedMongoDB(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MongoDBList result = apiInstance.listNamespacedMongoDB(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MongoDBList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedMySQL

V1alpha1MySQLList listNamespacedMySQL(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1MySQLList result = apiInstance.listNamespacedMySQL(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1MySQLList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedPostgres

V1alpha1PostgresList listNamespacedPostgres(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1PostgresList result = apiInstance.listNamespacedPostgres(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1PostgresList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedRedis

V1alpha1RedisList listNamespacedRedis(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1RedisList result = apiInstance.listNamespacedRedis(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1RedisList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listNamespacedSnapshot

V1alpha1SnapshotList listNamespacedSnapshot(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1SnapshotList result = apiInstance.listNamespacedSnapshot(namespace, pretty, _continue, fieldSelector, includeUninitialized, labelSelector, limit, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1SnapshotList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listPostgresForAllNamespaces

V1alpha1PostgresList listPostgresForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1PostgresList result = apiInstance.listPostgresForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listPostgresForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1PostgresList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listRedisForAllNamespaces

V1alpha1RedisList listRedisForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1RedisList result = apiInstance.listRedisForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listRedisForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1RedisList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

listSnapshotForAllNamespaces

V1alpha1SnapshotList listSnapshotForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch)

list or watch objects of kind Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String _continue = "_continue_example"; // String | 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 indicating the client must restart their list without the continue field. 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.
String fieldSelector = "fieldSelector_example"; // String | A selector to restrict the list of returned objects by their fields. Defaults to everything.
Boolean includeUninitialized = true; // Boolean | If true, partially initialized resources are included in the response.
String labelSelector = "labelSelector_example"; // String | A selector to restrict the list of returned objects by their labels. Defaults to everything.
Integer limit = 56; // Integer | 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.
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
String resourceVersion = "resourceVersion_example"; // String | 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.
Integer timeoutSeconds = 56; // Integer | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
Boolean watch = true; // Boolean | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
try {
    V1alpha1SnapshotList result = apiInstance.listSnapshotForAllNamespaces(_continue, fieldSelector, includeUninitialized, labelSelector, limit, pretty, resourceVersion, timeoutSeconds, watch);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#listSnapshotForAllNamespaces");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
_continueStringThe 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 indicating the client must restart their list without the continue field. 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]
fieldSelectorStringA selector to restrict the list of returned objects by their fields. Defaults to everything.[optional]
includeUninitializedBooleanIf true, partially initialized resources are included in the response.[optional]
labelSelectorStringA selector to restrict the list of returned objects by their labels. Defaults to everything.[optional]
limitIntegerlimit 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]
prettyStringIf 'true', then the output is pretty printed.[optional]
resourceVersionStringWhen 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]
timeoutSecondsIntegerTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.[optional]
watchBooleanWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.[optional]

Return type

V1alpha1SnapshotList

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

patchNamespacedDormantDatabase

V1alpha1DormantDatabase patchNamespacedDormantDatabase(name, namespace, body, pretty)

partially update the specified DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the DormantDatabase
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1DormantDatabase result = apiInstance.patchNamespacedDormantDatabase(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the DormantDatabase
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1DormantDatabase

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedElasticsearch

V1alpha1Elasticsearch patchNamespacedElasticsearch(name, namespace, body, pretty)

partially update the specified Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Elasticsearch
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Elasticsearch result = apiInstance.patchNamespacedElasticsearch(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Elasticsearch
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Elasticsearch

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedMemcached

V1alpha1Memcached patchNamespacedMemcached(name, namespace, body, pretty)

partially update the specified Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Memcached
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Memcached result = apiInstance.patchNamespacedMemcached(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Memcached
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Memcached

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedMongoDB

V1alpha1MongoDB patchNamespacedMongoDB(name, namespace, body, pretty)

partially update the specified MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MongoDB
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MongoDB result = apiInstance.patchNamespacedMongoDB(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MongoDB
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MongoDB

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedMySQL

V1alpha1MySQL patchNamespacedMySQL(name, namespace, body, pretty)

partially update the specified MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MySQL
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MySQL result = apiInstance.patchNamespacedMySQL(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MySQL
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MySQL

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedPostgres

V1alpha1Postgres patchNamespacedPostgres(name, namespace, body, pretty)

partially update the specified Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Postgres
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Postgres result = apiInstance.patchNamespacedPostgres(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Postgres
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Postgres

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedRedis

V1alpha1Redis patchNamespacedRedis(name, namespace, body, pretty)

partially update the specified Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Redis
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Redis result = apiInstance.patchNamespacedRedis(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Redis
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Redis

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

patchNamespacedSnapshot

V1alpha1Snapshot patchNamespacedSnapshot(name, namespace, body, pretty)

partially update the specified Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Snapshot
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
Object body = null; // Object | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Snapshot result = apiInstance.patchNamespacedSnapshot(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#patchNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Snapshot
namespaceStringobject name and auth scope, such as for teams and projects
bodyObject
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Snapshot

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedDormantDatabase

V1alpha1DormantDatabase readNamespacedDormantDatabase(name, namespace, pretty)

read the specified DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the DormantDatabase
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1DormantDatabase result = apiInstance.readNamespacedDormantDatabase(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the DormantDatabase
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1DormantDatabase

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedElasticsearch

V1alpha1Elasticsearch readNamespacedElasticsearch(name, namespace, pretty)

read the specified Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Elasticsearch
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Elasticsearch result = apiInstance.readNamespacedElasticsearch(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Elasticsearch
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Elasticsearch

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedMemcached

V1alpha1Memcached readNamespacedMemcached(name, namespace, pretty)

read the specified Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Memcached
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Memcached result = apiInstance.readNamespacedMemcached(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Memcached
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Memcached

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedMongoDB

V1alpha1MongoDB readNamespacedMongoDB(name, namespace, pretty)

read the specified MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MongoDB
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MongoDB result = apiInstance.readNamespacedMongoDB(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MongoDB
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MongoDB

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedMySQL

V1alpha1MySQL readNamespacedMySQL(name, namespace, pretty)

read the specified MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MySQL
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MySQL result = apiInstance.readNamespacedMySQL(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MySQL
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MySQL

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedPostgres

V1alpha1Postgres readNamespacedPostgres(name, namespace, pretty)

read the specified Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Postgres
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Postgres result = apiInstance.readNamespacedPostgres(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Postgres
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Postgres

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedRedis

V1alpha1Redis readNamespacedRedis(name, namespace, pretty)

read the specified Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Redis
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Redis result = apiInstance.readNamespacedRedis(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Redis
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Redis

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

readNamespacedSnapshot

V1alpha1Snapshot readNamespacedSnapshot(name, namespace, pretty)

read the specified Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Snapshot
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Snapshot result = apiInstance.readNamespacedSnapshot(name, namespace, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#readNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Snapshot
namespaceStringobject name and auth scope, such as for teams and projects
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Snapshot

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedDormantDatabase

V1alpha1DormantDatabase replaceNamespacedDormantDatabase(name, namespace, body, pretty)

replace the specified DormantDatabase

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the DormantDatabase
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1DormantDatabase body = new V1alpha1DormantDatabase(); // V1alpha1DormantDatabase | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1DormantDatabase result = apiInstance.replaceNamespacedDormantDatabase(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedDormantDatabase");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the DormantDatabase
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1DormantDatabase
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1DormantDatabase

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedElasticsearch

V1alpha1Elasticsearch replaceNamespacedElasticsearch(name, namespace, body, pretty)

replace the specified Elasticsearch

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Elasticsearch
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Elasticsearch body = new V1alpha1Elasticsearch(); // V1alpha1Elasticsearch | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Elasticsearch result = apiInstance.replaceNamespacedElasticsearch(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedElasticsearch");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Elasticsearch
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Elasticsearch
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Elasticsearch

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedMemcached

V1alpha1Memcached replaceNamespacedMemcached(name, namespace, body, pretty)

replace the specified Memcached

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Memcached
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Memcached body = new V1alpha1Memcached(); // V1alpha1Memcached | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Memcached result = apiInstance.replaceNamespacedMemcached(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedMemcached");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Memcached
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Memcached
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Memcached

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedMongoDB

V1alpha1MongoDB replaceNamespacedMongoDB(name, namespace, body, pretty)

replace the specified MongoDB

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MongoDB
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1MongoDB body = new V1alpha1MongoDB(); // V1alpha1MongoDB | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MongoDB result = apiInstance.replaceNamespacedMongoDB(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedMongoDB");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MongoDB
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1MongoDB
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MongoDB

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedMySQL

V1alpha1MySQL replaceNamespacedMySQL(name, namespace, body, pretty)

replace the specified MySQL

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the MySQL
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1MySQL body = new V1alpha1MySQL(); // V1alpha1MySQL | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1MySQL result = apiInstance.replaceNamespacedMySQL(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedMySQL");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the MySQL
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1MySQL
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1MySQL

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedPostgres

V1alpha1Postgres replaceNamespacedPostgres(name, namespace, body, pretty)

replace the specified Postgres

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Postgres
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Postgres body = new V1alpha1Postgres(); // V1alpha1Postgres | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Postgres result = apiInstance.replaceNamespacedPostgres(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedPostgres");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Postgres
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Postgres
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Postgres

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedRedis

V1alpha1Redis replaceNamespacedRedis(name, namespace, body, pretty)

replace the specified Redis

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Redis
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Redis body = new V1alpha1Redis(); // V1alpha1Redis | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Redis result = apiInstance.replaceNamespacedRedis(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedRedis");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Redis
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Redis
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Redis

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

replaceNamespacedSnapshot

V1alpha1Snapshot replaceNamespacedSnapshot(name, namespace, body, pretty)

replace the specified Snapshot

Example

// Import classes:
//import com.kubedb.client.ApiException;
//import com.kubedb.client.apis.KubedbComV1alpha1Api;


KubedbComV1alpha1Api apiInstance = new KubedbComV1alpha1Api();
String name = "name_example"; // String | name of the Snapshot
String namespace = "namespace_example"; // String | object name and auth scope, such as for teams and projects
V1alpha1Snapshot body = new V1alpha1Snapshot(); // V1alpha1Snapshot | 
String pretty = "pretty_example"; // String | If 'true', then the output is pretty printed.
try {
    V1alpha1Snapshot result = apiInstance.replaceNamespacedSnapshot(name, namespace, body, pretty);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling KubedbComV1alpha1Api#replaceNamespacedSnapshot");
    e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
nameStringname of the Snapshot
namespaceStringobject name and auth scope, such as for teams and projects
bodyV1alpha1Snapshot
prettyStringIf 'true', then the output is pretty printed.[optional]

Return type

V1alpha1Snapshot

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf