Package com.cloudera.cdp.opdb.api

Class OpdbClient

java.lang.Object

com.cloudera.cdp.client.CdpClient

com.cloudera.cdp.opdb.api.OpdbClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2023-09-27T13:27:53.629-07:00")
public class OpdbClient
extends CdpClient

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Fields inherited from class com.cloudera.cdp.client.CdpClient

NO_EXTENSION

Constructor Summary

Constructors

Constructor	Description
OpdbClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
OpdbClient(CdpRequestContext<?> context)

Method Summary

Modifier and Type	Method	Description
CollectDiagnosticsResponse	collectDiagnostics(CollectDiagnosticsRequest input)	Collect diagnostic data bundles from the database
CreateDatabaseResponse	createDatabase(CreateDatabaseRequest input)	Create opDb
DescribeClientConnectivityResponse	describeClientConnectivity(DescribeClientConnectivityRequest input)	Returns client connectivity details
DescribeDatabaseResponse	describeDatabase(DescribeDatabaseRequest input)	Describe a opDb
DescribeUpgradeDatabaseResponse	describeUpgradeDatabase(DescribeUpgradeDatabaseRequest input)	Describes the upgrade availability.
DropDatabaseResponse	dropDatabase(DropDatabaseRequest input)	drop a opDb
protected String	getRequestContentType()	Gets the request Content-Type, used by 'Conent-Type' request header.
protected String	getResponseContentType()	Gets the expected response Content-Type, used by 'Accept' request header.
protected String	getServiceName()	Gets the service name.
ListDatabasesResponse	listDatabases(ListDatabasesRequest input)	List all opDbs in an environment
ListDiagnosticsResponse	listDiagnostics(ListDiagnosticsRequest input)	List all diagnostics associated to the database
ListSupportedEnvironmentsResponse	listSupportedEnvironments(ListSupportedEnvironmentsRequest input)	List of environments available for the database creation
StartDatabaseResponse	startDatabase(StartDatabaseRequest input)	Starts the database
StopDatabaseResponse	stopDatabase(StopDatabaseRequest input)	Stops the database
UpgradeDatabaseResponse	upgradeDatabase(UpgradeDatabaseRequest input)	Upgrades the database.

Methods inherited from class com.cloudera.cdp.client.CdpClient

invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

OpdbClient

public OpdbClient(CdpCredentials credentials,
                  String endPoint,
                  CdpClientConfiguration clientConfiguration)

OpdbClient

public OpdbClient(CdpRequestContext<?> context)

Method Detail

getServiceName

protected String getServiceName()

Description copied from class: CdpClient

Gets the service name.

Specified by:

getServiceName in class CdpClient

Returns:

the service name

getRequestContentType

protected String getRequestContentType()

Description copied from class: CdpClient

Gets the request Content-Type, used by 'Conent-Type' request header.

Overrides:

getRequestContentType in class CdpClient

Returns:

the request Content-Type

getResponseContentType

protected String getResponseContentType()

Description copied from class: CdpClient

Gets the expected response Content-Type, used by 'Accept' request header.

Overrides:

getResponseContentType in class CdpClient

Returns:

the response Content-Type

collectDiagnostics

public CollectDiagnosticsResponse collectDiagnostics(CollectDiagnosticsRequest input)

Collect diagnostic data bundles from the database

Parameters:

input -

Returns:

CollectDiagnosticsResponse

createDatabase

public CreateDatabaseResponse createDatabase(CreateDatabaseRequest input)

Create opDb

Parameters:

input -

Returns:

CreateDatabaseResponse

describeClientConnectivity

public DescribeClientConnectivityResponse describeClientConnectivity(DescribeClientConnectivityRequest input)

Returns client connectivity details

Parameters:

input -

Returns:

DescribeClientConnectivityResponse

describeDatabase

public DescribeDatabaseResponse describeDatabase(DescribeDatabaseRequest input)

Describe a opDb

Parameters:

input -

Returns:

DescribeDatabaseResponse

describeUpgradeDatabase

public DescribeUpgradeDatabaseResponse describeUpgradeDatabase(DescribeUpgradeDatabaseRequest input)

Describes the upgrade availability.

Parameters:

input -

Returns:

DescribeUpgradeDatabaseResponse

dropDatabase

public DropDatabaseResponse dropDatabase(DropDatabaseRequest input)

drop a opDb

Parameters:

input -

Returns:

DropDatabaseResponse

listDatabases

public ListDatabasesResponse listDatabases(ListDatabasesRequest input)

List all opDbs in an environment

Parameters:

input -

Returns:

ListDatabasesResponse

listDiagnostics

public ListDiagnosticsResponse listDiagnostics(ListDiagnosticsRequest input)

List all diagnostics associated to the database

Parameters:

input -

Returns:

ListDiagnosticsResponse

listSupportedEnvironments

public ListSupportedEnvironmentsResponse listSupportedEnvironments(ListSupportedEnvironmentsRequest input)

List of environments available for the database creation

Parameters:

input -

Returns:

ListSupportedEnvironmentsResponse

startDatabase

public StartDatabaseResponse startDatabase(StartDatabaseRequest input)

Starts the database

Parameters:

input -

Returns:

StartDatabaseResponse

stopDatabase

public StopDatabaseResponse stopDatabase(StopDatabaseRequest input)

Stops the database

Parameters:

input -

Returns:

StopDatabaseResponse

upgradeDatabase

public UpgradeDatabaseResponse upgradeDatabase(UpgradeDatabaseRequest input)

Upgrades the database.

Parameters:

input -

Returns:

UpgradeDatabaseResponse