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>

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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).

Method Summary

Modifier and Type	Method and Description
static ListDbSystemsRequest.Builder	builder()
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).

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ListDbSystemsRequest.Builder builder()

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.