Class ListTargetDatabasesRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.datasafe.requests.ListTargetDatabasesRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListTargetDatabasesRequest,Void>
- Enclosing class:
- ListTargetDatabasesRequest
public static class ListTargetDatabasesRequest.Builder extends Object implements BmcRequest.Builder<ListTargetDatabasesRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListTargetDatabasesRequest.Builder
accessLevel(ListTargetDatabasesRequest.AccessLevel accessLevel)
Valid values are RESTRICTED and ACCESSIBLE.ListTargetDatabasesRequest.Builder
associatedResourceId(String associatedResourceId)
A filter to return the target databases that are associated to the resource id passed in as a parameter value.ListTargetDatabasesRequest
build()
Build the instance of ListTargetDatabasesRequest as configured by this builderListTargetDatabasesRequest
buildWithoutInvocationCallback()
Build the instance of ListTargetDatabasesRequest as configured by this builderListTargetDatabasesRequest.Builder
compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.ListTargetDatabasesRequest.Builder
compartmentIdInSubtree(Boolean compartmentIdInSubtree)
Default is false.ListTargetDatabasesRequest.Builder
copy(ListTargetDatabasesRequest o)
Copy method to populate the builder with values from the given instance.ListTargetDatabasesRequest.Builder
databaseType(DatabaseType databaseType)
A filter to return only target databases that match the specified database type.ListTargetDatabasesRequest.Builder
displayName(String displayName)
A filter to return only resources that match the specified display name.ListTargetDatabasesRequest.Builder
infrastructureType(InfrastructureType infrastructureType)
A filter to return only target databases that match the specified infrastructure type.ListTargetDatabasesRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListTargetDatabasesRequest.Builder
lifecycleState(TargetDatabaseLifecycleState lifecycleState)
A filter to return only target databases that match the specified lifecycle state.ListTargetDatabasesRequest.Builder
limit(Integer limit)
For list pagination.ListTargetDatabasesRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListTargetDatabasesRequest.Builder
page(String page)
For list pagination.ListTargetDatabasesRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListTargetDatabasesRequest.Builder
sortBy(ListTargetDatabasesRequest.SortBy sortBy)
The field used for sorting.ListTargetDatabasesRequest.Builder
sortOrder(ListTargetDatabasesRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).ListTargetDatabasesRequest.Builder
targetDatabaseId(String targetDatabaseId)
A filter to return the target database that matches the specified OCID.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$
-
-
-
-
Method Detail
-
compartmentId
public ListTargetDatabasesRequest.Builder compartmentId(String compartmentId)
A filter to return only resources that match the specified compartment OCID.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
associatedResourceId
public ListTargetDatabasesRequest.Builder associatedResourceId(String associatedResourceId)
A filter to return the target databases that are associated to the resource id passed in as a parameter value.- Parameters:
associatedResourceId
- the value to set- Returns:
- this builder instance
-
targetDatabaseId
public ListTargetDatabasesRequest.Builder targetDatabaseId(String targetDatabaseId)
A filter to return the target database that matches the specified OCID.- Parameters:
targetDatabaseId
- the value to set- Returns:
- this builder instance
-
displayName
public ListTargetDatabasesRequest.Builder displayName(String displayName)
A filter to return only resources that match the specified display name.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListTargetDatabasesRequest.Builder lifecycleState(TargetDatabaseLifecycleState lifecycleState)
A filter to return only target databases that match the specified lifecycle state.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
databaseType
public ListTargetDatabasesRequest.Builder databaseType(DatabaseType databaseType)
A filter to return only target databases that match the specified database type.- Parameters:
databaseType
- the value to set- Returns:
- this builder instance
-
infrastructureType
public ListTargetDatabasesRequest.Builder infrastructureType(InfrastructureType infrastructureType)
A filter to return only target databases that match the specified infrastructure type.- Parameters:
infrastructureType
- the value to set- Returns:
- this builder instance
-
limit
public ListTargetDatabasesRequest.Builder limit(Integer limit)
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.
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListTargetDatabasesRequest.Builder page(String page)
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.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListTargetDatabasesRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
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.
- Parameters:
compartmentIdInSubtree
- the value to set- Returns:
- this builder instance
-
accessLevel
public ListTargetDatabasesRequest.Builder accessLevel(ListTargetDatabasesRequest.AccessLevel accessLevel)
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.
- Parameters:
accessLevel
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListTargetDatabasesRequest.Builder sortOrder(ListTargetDatabasesRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
sortBy
public ListTargetDatabasesRequest.Builder sortBy(ListTargetDatabasesRequest.SortBy sortBy)
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.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListTargetDatabasesRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListTargetDatabasesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.- Parameters:
invocationCallback
- the invocation callback to be set for the request- Returns:
- this builder instance
-
retryConfiguration
public ListTargetDatabasesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.- Parameters:
retryConfiguration
- the retry configuration to be used for the request- Returns:
- this builder instance
-
copy
public ListTargetDatabasesRequest.Builder copy(ListTargetDatabasesRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListTargetDatabasesRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListTargetDatabasesRequest build()
Build the instance of ListTargetDatabasesRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListTargetDatabasesRequest,Void>
- Returns:
- instance of ListTargetDatabasesRequest
-
buildWithoutInvocationCallback
public ListTargetDatabasesRequest buildWithoutInvocationCallback()
Build the instance of ListTargetDatabasesRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListTargetDatabasesRequest
-
-