org.openmetadata.client.api.DatabaseServicesApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.CreateDatabaseService;
import org.openmetadata.client.model.CsvImportResult;
import org.openmetadata.client.model.DatabaseService;
import org.openmetadata.client.model.DatabaseServiceList;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TestConnectionResult;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-06-12T14:45:46.761684912Z[Etc/UTC]")
public interface DatabaseServicesApi extends ApiClient.Api {
/**
* Add test connection result
* Add test connection result to the service.
* @param id Id of the service (required)
* @param testConnectionResult (optional)
* @return DatabaseService
*/
@RequestLine("PUT /v1/services/databaseServices/{id}/testConnectionResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DatabaseService addTestConnectionResult1(@Param("id") UUID id, TestConnectionResult testConnectionResult);
/**
* Add test connection result
* Similar to addTestConnectionResult1 but it also returns the http response headers .
* Add test connection result to the service.
* @param id Id of the service (required)
* @param testConnectionResult (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/databaseServices/{id}/testConnectionResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addTestConnectionResult1WithHttpInfo(@Param("id") UUID id, TestConnectionResult testConnectionResult);
/**
* Create database service
* Create a new database service.
* @param createDatabaseService (optional)
* @return DatabaseService
*/
@RequestLine("POST /v1/services/databaseServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DatabaseService createDatabaseService(CreateDatabaseService createDatabaseService);
/**
* Create database service
* Similar to createDatabaseService but it also returns the http response headers .
* Create a new database service.
* @param createDatabaseService (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/databaseServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDatabaseServiceWithHttpInfo(CreateDatabaseService createDatabaseService);
/**
* Update database service
* Update an existing or create a new database service.
* @param createDatabaseService (optional)
* @return DatabaseService
*/
@RequestLine("PUT /v1/services/databaseServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DatabaseService createOrUpdateDatabaseService(CreateDatabaseService createDatabaseService);
/**
* Update database service
* Similar to createOrUpdateDatabaseService but it also returns the http response headers .
* Update an existing or create a new database service.
* @param createDatabaseService (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/databaseServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDatabaseServiceWithHttpInfo(CreateDatabaseService createDatabaseService);
/**
* Delete a database service by Id
* Delete a database services. If databases (and tables) belong the service, it can't be deleted.
* @param id Id of the database service (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/databaseServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDatabaseService(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a database service by Id
* Similar to deleteDatabaseService but it also returns the http response headers .
* Delete a database services. If databases (and tables) belong the service, it can't be deleted.
* @param id Id of the database service (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/databaseServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDatabaseServiceWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a database service by Id
* Delete a database services. If databases (and tables) belong the service, it can't be deleted.
* Note, this is equivalent to the other deleteDatabaseService method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteDatabaseServiceQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/databaseServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDatabaseService(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDatabaseServiceQueryParams queryParams);
/**
* Delete a database service by Id
* Delete a database services. If databases (and tables) belong the service, it can't be deleted.
* Note, this is equivalent to the other deleteDatabaseService that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/databaseServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDatabaseServiceWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDatabaseServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDatabaseService method in a fluent style.
*/
public static class DeleteDatabaseServiceQueryParams extends HashMap {
public DeleteDatabaseServiceQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
public DeleteDatabaseServiceQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a database service by name
* Delete a database services by `name`. If databases (and tables) belong the service, it can't be deleted.
* @param name Name of the database service (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/databaseServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDatabaseServiceByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a database service by name
* Similar to deleteDatabaseServiceByName but it also returns the http response headers .
* Delete a database services by `name`. If databases (and tables) belong the service, it can't be deleted.
* @param name Name of the database service (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/databaseServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDatabaseServiceByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a database service by name
* Delete a database services by `name`. If databases (and tables) belong the service, it can't be deleted.
* Note, this is equivalent to the other deleteDatabaseServiceByName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteDatabaseServiceByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/databaseServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDatabaseServiceByName(@Param("name") String name, @QueryMap(encoded=true) DeleteDatabaseServiceByNameQueryParams queryParams);
/**
* Delete a database service by name
* Delete a database services by `name`. If databases (and tables) belong the service, it can't be deleted.
* Note, this is equivalent to the other deleteDatabaseServiceByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/databaseServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDatabaseServiceByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteDatabaseServiceByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDatabaseServiceByName method in a fluent style.
*/
public static class DeleteDatabaseServiceByNameQueryParams extends HashMap {
public DeleteDatabaseServiceByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteDatabaseServiceByNameQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Export database service in CSV format
*
* @param name Name of the Database Service (required)
* @return String
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}/export")
@Headers({
"Accept: application/json",
})
String exportDatabaseServices(@Param("name") String name);
/**
* Export database service in CSV format
* Similar to exportDatabaseServices but it also returns the http response headers .
*
* @param name Name of the Database Service (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}/export")
@Headers({
"Accept: application/json",
})
ApiResponse exportDatabaseServicesWithHttpInfo(@Param("name") String name);
/**
* Get database service by name
* Get a database service by the service `name`.
* @param name Name of the database service (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseService getDatabaseServiceByFQN(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get database service by name
* Similar to getDatabaseServiceByFQN but it also returns the http response headers .
* Get a database service by the service `name`.
* @param name Name of the database service (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDatabaseServiceByFQNWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get database service by name
* Get a database service by the service `name`.
* Note, this is equivalent to the other getDatabaseServiceByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetDatabaseServiceByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseService getDatabaseServiceByFQN(@Param("name") String name, @QueryMap(encoded=true) GetDatabaseServiceByFQNQueryParams queryParams);
/**
* Get database service by name
* Get a database service by the service `name`.
* Note, this is equivalent to the other getDatabaseServiceByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDatabaseServiceByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetDatabaseServiceByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDatabaseServiceByFQN method in a fluent style.
*/
public static class GetDatabaseServiceByFQNQueryParams extends HashMap {
public GetDatabaseServiceByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDatabaseServiceByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a database service
* Get a database service by `Id`.
* @param id Id of the database service (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseService getDatabaseServiceByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a database service
* Similar to getDatabaseServiceByID but it also returns the http response headers .
* Get a database service by `Id`.
* @param id Id of the database service (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDatabaseServiceByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a database service
* Get a database service by `Id`.
* Note, this is equivalent to the other getDatabaseServiceByID method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetDatabaseServiceByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseService getDatabaseServiceByID(@Param("id") UUID id, @QueryMap(encoded=true) GetDatabaseServiceByIDQueryParams queryParams);
/**
* Get a database service
* Get a database service by `Id`.
* Note, this is equivalent to the other getDatabaseServiceByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the database service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDatabaseServiceByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetDatabaseServiceByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDatabaseServiceByID method in a fluent style.
*/
public static class GetDatabaseServiceByIDQueryParams extends HashMap {
public GetDatabaseServiceByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDatabaseServiceByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the database service
* Get a version of the database service by given `Id`
* @param id Id of the database service (required)
* @param version database service version number in the form `major`.`minor` (required)
* @return DatabaseService
*/
@RequestLine("GET /v1/services/databaseServices/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
DatabaseService getSpecificDatabaseServiceVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the database service
* Similar to getSpecificDatabaseServiceVersion but it also returns the http response headers .
* Get a version of the database service by given `Id`
* @param id Id of the database service (required)
* @param version database service version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificDatabaseServiceVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Import service from CSV to update database service (no creation allowed)
*
* @param name Name of the Database Service (required)
* @param dryRun Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
* @param body (optional)
* @return CsvImportResult
*/
@RequestLine("PUT /v1/services/databaseServices/name/{name}/import?dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
CsvImportResult importDatabaseService(@Param("name") String name, @Param("dryRun") Boolean dryRun, String body);
/**
* Import service from CSV to update database service (no creation allowed)
* Similar to importDatabaseService but it also returns the http response headers .
*
* @param name Name of the Database Service (required)
* @param dryRun Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
* @param body (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/databaseServices/name/{name}/import?dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
ApiResponse importDatabaseServiceWithHttpInfo(@Param("name") String name, @Param("dryRun") Boolean dryRun, String body);
/**
* Import service from CSV to update database service (no creation allowed)
*
* Note, this is equivalent to the other importDatabaseService method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ImportDatabaseServiceQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the Database Service (required)
* @param body (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - dryRun - Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
*
* @return CsvImportResult
*/
@RequestLine("PUT /v1/services/databaseServices/name/{name}/import?dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
CsvImportResult importDatabaseService(@Param("name") String name, String body, @QueryMap(encoded=true) ImportDatabaseServiceQueryParams queryParams);
/**
* Import service from CSV to update database service (no creation allowed)
*
* Note, this is equivalent to the other importDatabaseService that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the Database Service (required)
* @param body (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - dryRun - Dry-run when true is used for validating the CSV without really importing it. (default=true) (optional, default to true)
*
* @return CsvImportResult
*/
@RequestLine("PUT /v1/services/databaseServices/name/{name}/import?dryRun={dryRun}")
@Headers({
"Content-Type: text/plain",
"Accept: application/json",
})
ApiResponse importDatabaseServiceWithHttpInfo(@Param("name") String name, String body, @QueryMap(encoded=true) ImportDatabaseServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* importDatabaseService method in a fluent style.
*/
public static class ImportDatabaseServiceQueryParams extends HashMap {
public ImportDatabaseServiceQueryParams dryRun(final Boolean value) {
put("dryRun", EncodingUtils.encode(value));
return this;
}
}
/**
* List database service versions
* Get a list of all the versions of a database service identified by `Id`
* @param id Id of the database service (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/services/databaseServices/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDatabaseServiceVersion(@Param("id") UUID id);
/**
* List database service versions
* Similar to listAllDatabaseServiceVersion but it also returns the http response headers .
* Get a list of all the versions of a database service identified by `Id`
* @param id Id of the database service (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDatabaseServiceVersionWithHttpInfo(@Param("id") UUID id);
/**
* List database services
* Get a list of database services.
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter services by domain (optional)
* @param limit (optional, default to 10)
* @param before Returns list of database services before this cursor (optional)
* @param after Returns list of database services after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return DatabaseServiceList
*/
@RequestLine("GET /v1/services/databaseServices?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseServiceList listDatabaseServices(@Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List database services
* Similar to listDatabaseServices but it also returns the http response headers .
* Get a list of database services.
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter services by domain (optional)
* @param limit (optional, default to 10)
* @param before Returns list of database services before this cursor (optional)
* @param after Returns list of database services after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/databaseServices?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDatabaseServicesWithHttpInfo(@Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List database services
* Get a list of database services.
* Note, this is equivalent to the other listDatabaseServices method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListDatabaseServicesQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - domain - Filter services by domain (optional)
* - limit - (optional, default to 10)
* - before - Returns list of database services before this cursor (optional)
* - after - Returns list of database services after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseServiceList
*/
@RequestLine("GET /v1/services/databaseServices?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DatabaseServiceList listDatabaseServices(@QueryMap(encoded=true) ListDatabaseServicesQueryParams queryParams);
/**
* List database services
* Get a list of database services.
* Note, this is equivalent to the other listDatabaseServices that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - domain - Filter services by domain (optional)
* - limit - (optional, default to 10)
* - before - Returns list of database services before this cursor (optional)
* - after - Returns list of database services after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DatabaseServiceList
*/
@RequestLine("GET /v1/services/databaseServices?fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDatabaseServicesWithHttpInfo(@QueryMap(encoded=true) ListDatabaseServicesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDatabaseServices method in a fluent style.
*/
public static class ListDatabaseServicesQueryParams extends HashMap {
public ListDatabaseServicesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListDatabaseServicesQueryParams domain(final String value) {
put("domain", EncodingUtils.encode(value));
return this;
}
public ListDatabaseServicesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDatabaseServicesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDatabaseServicesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListDatabaseServicesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a database service using name.
* Update an existing database service using JsonPatch.
* @param fqn Name of the database service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a database service using name. Documentation
*/
@RequestLine("PATCH /v1/services/databaseServices/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDatabaseService(@Param("fqn") String fqn, Object body);
/**
* Update a database service using name.
* Similar to patchDatabaseService but it also returns the http response headers .
* Update an existing database service using JsonPatch.
* @param fqn Name of the database service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a database service using name. Documentation
*/
@RequestLine("PATCH /v1/services/databaseServices/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDatabaseServiceWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a database service
* Update an existing database service using JsonPatch.
* @param id Id of the database service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a database service Documentation
*/
@RequestLine("PATCH /v1/services/databaseServices/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDatabaseService1(@Param("id") UUID id, Object body);
/**
* Update a database service
* Similar to patchDatabaseService1 but it also returns the http response headers .
* Update an existing database service using JsonPatch.
* @param id Id of the database service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a database service Documentation
*/
@RequestLine("PATCH /v1/services/databaseServices/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDatabaseService1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted database service
* Restore a soft deleted database service.
* @param restoreEntity (optional)
* @return DatabaseService
*/
@RequestLine("PUT /v1/services/databaseServices/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DatabaseService restore21(RestoreEntity restoreEntity);
/**
* Restore a soft deleted database service
* Similar to restore21 but it also returns the http response headers .
* Restore a soft deleted database service.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/databaseServices/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore21WithHttpInfo(RestoreEntity restoreEntity);
}