Package 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>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/database/ListDbHomesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDbHomesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListDbHomesRequest.Builderstatic classListDbHomesRequest.SortByThe field to sort by.static classListDbHomesRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListDbHomesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListDbHomesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetBackupId()The OCID of the backup.StringgetCompartmentId()The compartment OCID.StringgetDbSystemId()The DB system OCID.StringgetDbVersion()A filter to return only DB Homes that match the specified dbVersion.StringgetDisplayName()A filter to return only resources that match the entire display name given.DbHomeSummary.LifecycleStategetLifecycleState()A filter to return only resources that match the given lifecycle state exactly.IntegergetLimit()The maximum number of items to return per page.StringgetPage()The pagination token to continue listing from.ListDbHomesRequest.SortBygetSortBy()The field to sort by.ListDbHomesRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetVmClusterId()The OCID of the VM cluster.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListDbHomesRequest.BuildertoBuilder()Return an instance ofListDbHomesRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
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.
-
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.
-
getDbVersion
public String getDbVersion()
A filter to return only DB Homes that match the specified dbVersion.
-
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.
-
toBuilder
public ListDbHomesRequest.Builder toBuilder()
Return an instance ofListDbHomesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListDbHomesRequest.Builderthat allows you to modify request properties.
-
builder
public static ListDbHomesRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-