Class ListTargetDatabasesRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListTargetDatabasesRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListTargetDatabasesRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListTargetDatabasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTargetDatabasesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListTargetDatabasesRequest.AccessLevelValid values are RESTRICTED and ACCESSIBLE.static classListTargetDatabasesRequest.Builderstatic classListTargetDatabasesRequest.SortByThe field used for sorting.static classListTargetDatabasesRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListTargetDatabasesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTargetDatabasesRequest.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’.ListTargetDatabasesRequest.AccessLevelgetAccessLevel()Valid values are RESTRICTED and ACCESSIBLE.StringgetAssociatedResourceId()A filter to return the target databases that are associated to the resource id passed in as a parameter value.StringgetCompartmentId()A filter to return only resources that match the specified compartment OCID.BooleangetCompartmentIdInSubtree()Default is false.DatabaseTypegetDatabaseType()A filter to return only target databases that match the specified database type.StringgetDisplayName()A filter to return only resources that match the specified display name.InfrastructureTypegetInfrastructureType()A filter to return only target databases that match the specified infrastructure type.TargetDatabaseLifecycleStategetLifecycleState()A filter to return only target databases that match the specified lifecycle state.IntegergetLimit()For list pagination.StringgetOpcRequestId()Unique identifier for the request.StringgetPage()For list pagination.ListTargetDatabasesRequest.SortBygetSortBy()The field used for sorting.ListTargetDatabasesRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetTargetDatabaseId()A filter to return the target database that matches the specified OCID.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListTargetDatabasesRequest.BuildertoBuilder()Return an instance ofListTargetDatabasesRequest.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
-
getCompartmentId
public String getCompartmentId()
A filter to return only resources that match the specified compartment OCID.
-
getAssociatedResourceId
public String getAssociatedResourceId()
A filter to return the target databases that are associated to the resource id passed in as a parameter value.
-
getTargetDatabaseId
public String getTargetDatabaseId()
A filter to return the target database that matches the specified OCID.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
getLifecycleState
public TargetDatabaseLifecycleState getLifecycleState()
A filter to return only target databases that match the specified lifecycle state.
-
getDatabaseType
public DatabaseType getDatabaseType()
A filter to return only target databases that match the specified database type.
-
getInfrastructureType
public InfrastructureType getInfrastructureType()
A filter to return only target databases that match the specified infrastructure type.
-
getLimit
public Integer getLimit()
For list pagination.The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.
-
getPage
public String getPage()
For list pagination.The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.
-
getCompartmentIdInSubtree
public Boolean getCompartmentIdInSubtree()
Default is false.When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.
-
getAccessLevel
public ListTargetDatabasesRequest.AccessLevel getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
-
getSortOrder
public ListTargetDatabasesRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListTargetDatabasesRequest.SortBy getSortBy()
The field used for sorting.Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
toBuilder
public ListTargetDatabasesRequest.Builder toBuilder()
Return an instance ofListTargetDatabasesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListTargetDatabasesRequest.Builderthat allows you to modify request properties.
-
builder
public static ListTargetDatabasesRequest.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>
-
-