Package com.oracle.bmc.database.requests

Class ListDbSystemsRequest

java.lang.Object

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

com.oracle.bmc.database.requests.ListDbSystemsRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListDbSystemsRequest()

Method Summary

Modifier and Type	Method	Description
static ListDbSystemsRequest.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	getAvailabilityDomain()	A filter to return only resources that match the given availability domain exactly.
String	getBackupId()	The OCID of the backup.
String	getCompartmentId()	The compartment OCID.
String	getDisplayName()	A filter to return only resources that match the entire display name given.
DbSystemSummary.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.
ListDbSystemsRequest.SortBy	getSortBy()	The field to sort by.
ListDbSystemsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDbSystemsRequest.Builder	toBuilder()	Return an instance of ListDbSystemsRequest.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

ListDbSystemsRequest

public ListDbSystemsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The compartment OCID.

getLimit

public Integer getLimit()

The maximum number of items to return per page.

getPage

public String getPage()

The pagination token to continue listing from.

getBackupId

public String getBackupId()

The OCID of the backup.

Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.

getSortBy

public ListDbSystemsRequest.SortBy getSortBy()

The field to sort by.

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

*Note:** If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.

getSortOrder

public ListDbSystemsRequest.SortOrder getSortOrder()

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

getLifecycleState

public DbSystemSummary.LifecycleState getLifecycleState()

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

getAvailabilityDomain

public String getAvailabilityDomain()

A filter to return only resources that match the given availability domain exactly.

getDisplayName

public String getDisplayName()

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

The match is not case sensitive.

toBuilder

public ListDbSystemsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListDbSystemsRequest.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>