Package com.oracle.bmc.database.requests

Class ListDatabasesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.database.requests.ListDatabasesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListDatabasesRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/database/ListDatabasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabasesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListDatabasesRequest.Builder
static class	ListDatabasesRequest.SortBy	The field to sort by.
static class	ListDatabasesRequest.SortOrder	The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor	Description
ListDatabasesRequest()

Method Summary

Modifier and Type	Method	Description
static ListDatabasesRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The compartment OCID.
String	getDbHomeId()	A Database Home OCID.
String	getDbName()	A filter to return only resources that match the entire database name given.
DatabaseSummary.LifecycleState	getLifecycleState()	A filter to return only resources that match the given lifecycle state exactly.
Integer	getLimit()	The maximum number of items to return per page.
String	getPage()	The pagination token to continue listing from.
ListDatabasesRequest.SortBy	getSortBy()	The field to sort by.
ListDatabasesRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
String	getSystemId()	The OCID of the Exadata DB system that you want to filter the database results by.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDatabasesRequest.Builder	toBuilder()	Return an instance of ListDatabasesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListDatabasesRequest

public ListDatabasesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The compartment OCID.

getDbHomeId

public String getDbHomeId()

A Database Home OCID.

getSystemId

public String getSystemId()

The OCID of the Exadata DB system that you want to filter the database results by.

Applies only to Exadata DB systems.

getLimit

public Integer getLimit()

The maximum number of items to return per page.

getPage

public String getPage()

The pagination token to continue listing from.

getSortBy

public ListDatabasesRequest.SortBy getSortBy()

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive.

getSortOrder

public ListDatabasesRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

getLifecycleState

public DatabaseSummary.LifecycleState getLifecycleState()

A filter to return only resources that match the given lifecycle state exactly.

getDbName

public String getDbName()

A filter to return only resources that match the entire database name given.

The match is not case sensitive.

toBuilder

public ListDatabasesRequest.Builder toBuilder()

Return an instance of ListDatabasesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListDatabasesRequest.Builder that allows you to modify request properties.

builder

public static ListDatabasesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>