com.oracle.bmc.database.requests

Class ListDbHomesRequest

java.lang.Object

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

com.oracle.bmc.database.requests.ListDbHomesRequest

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ListDbHomesRequest.Builder	builder()
String	getBackupId() The OCID of the backup.
String	getCompartmentId() The compartment OCID.
String	getDbSystemId() The DB system OCID.
String	getDisplayName() A filter to return only resources that match the entire display name given.
DbHomeSummary.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.
ListDbHomesRequest.SortBy	getSortBy() The field to sort by.
ListDbHomesRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getVmClusterId() The OCID of the VM cluster.

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 ListDbHomesRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The compartment OCID.

getDbSystemId

public String getDbSystemId()

The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

getVmClusterId

public String getVmClusterId()

The OCID of the VM cluster.

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.

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 ListDbHomesRequest.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.

getSortOrder

public ListDbHomesRequest.SortOrder getSortOrder()

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

getLifecycleState

public DbHomeSummary.LifecycleState getLifecycleState()

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

getDisplayName

public String getDisplayName()

A filter to return only resources that match the entire display name given. The match is not case sensitive.