Class ListDbSystemsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.mysql.requests.ListDbSystemsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListDbSystemsRequest,Void>
- Enclosing class:
- ListDbSystemsRequest
public static class ListDbSystemsRequest.Builder extends Object implements BmcRequest.Builder<ListDbSystemsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListDbSystemsRequest
build()
Build the instance of ListDbSystemsRequest as configured by this builderListDbSystemsRequest
buildWithoutInvocationCallback()
Build the instance of ListDbSystemsRequest as configured by this builderListDbSystemsRequest.Builder
compartmentId(String compartmentId)
The compartment OCID.ListDbSystemsRequest.Builder
configurationId(String configurationId)
The requested Configuration instance.ListDbSystemsRequest.Builder
copy(ListDbSystemsRequest o)
Copy method to populate the builder with values from the given instance.ListDbSystemsRequest.Builder
databaseManagement(ListDbSystemsRequest.DatabaseManagement singularValue)
Singular setter.ListDbSystemsRequest.Builder
databaseManagement(List<ListDbSystemsRequest.DatabaseManagement> databaseManagement)
Filter DB Systems by their Database Management configuration.ListDbSystemsRequest.Builder
dbSystemId(String dbSystemId)
The DB System OCID.ListDbSystemsRequest.Builder
displayName(String displayName)
A filter to return only the resource matching the given display name exactly.ListDbSystemsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListDbSystemsRequest.Builder
isHeatWaveClusterAttached(Boolean isHeatWaveClusterAttached)
If true, return only DB Systems with a HeatWave cluster attached, if false return only DB Systems with no HeatWave cluster attached.ListDbSystemsRequest.Builder
isUpToDate(Boolean isUpToDate)
Filter instances if they are using the latest revision of the Configuration they are associated with.ListDbSystemsRequest.Builder
lifecycleState(DbSystem.LifecycleState lifecycleState)
DbSystem Lifecycle StateListDbSystemsRequest.Builder
limit(Integer limit)
The maximum number of items to return in a paginated list call.ListDbSystemsRequest.Builder
opcRequestId(String opcRequestId)
Customer-defined unique identifier for the request.ListDbSystemsRequest.Builder
page(String page)
The value of the opc-next-page or opc-prev-page response header from the previous list call.ListDbSystemsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListDbSystemsRequest.Builder
sortBy(ListDbSystemsRequest.SortBy sortBy)
The field to sort by.ListDbSystemsRequest.Builder
sortOrder(ListDbSystemsRequest.SortOrder sortOrder)
The sort order to use (ASC or DESC).-
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 ListDbSystemsRequest.Builder compartmentId(String compartmentId)
The compartment OCID.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListDbSystemsRequest.Builder opcRequestId(String opcRequestId)
Customer-defined unique identifier for the request.If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request.
- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
isHeatWaveClusterAttached
public ListDbSystemsRequest.Builder isHeatWaveClusterAttached(Boolean isHeatWaveClusterAttached)
If true, return only DB Systems with a HeatWave cluster attached, if false return only DB Systems with no HeatWave cluster attached.If not present, return all DB Systems.
- Parameters:
isHeatWaveClusterAttached
- the value to set- Returns:
- this builder instance
-
dbSystemId
public ListDbSystemsRequest.Builder dbSystemId(String dbSystemId)
The DB System OCID.- Parameters:
dbSystemId
- the value to set- Returns:
- this builder instance
-
displayName
public ListDbSystemsRequest.Builder displayName(String displayName)
A filter to return only the resource matching the given display name exactly.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListDbSystemsRequest.Builder lifecycleState(DbSystem.LifecycleState lifecycleState)
DbSystem Lifecycle State- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
configurationId
public ListDbSystemsRequest.Builder configurationId(String configurationId)
The requested Configuration instance.- Parameters:
configurationId
- the value to set- Returns:
- this builder instance
-
isUpToDate
public ListDbSystemsRequest.Builder isUpToDate(Boolean isUpToDate)
Filter instances if they are using the latest revision of the Configuration they are associated with.- Parameters:
isUpToDate
- the value to set- Returns:
- this builder instance
-
databaseManagement
public ListDbSystemsRequest.Builder databaseManagement(List<ListDbSystemsRequest.DatabaseManagement> databaseManagement)
Filter DB Systems by their Database Management configuration.- Parameters:
databaseManagement
- the value to set- Returns:
- this builder instance
-
databaseManagement
public ListDbSystemsRequest.Builder databaseManagement(ListDbSystemsRequest.DatabaseManagement singularValue)
Singular setter.Filter DB Systems by their Database Management configuration.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
sortBy
public ListDbSystemsRequest.Builder sortBy(ListDbSystemsRequest.SortBy sortBy)
The field to sort by.Only one sort order may be provided. Time fields are default ordered as descending. Display name is default ordered as ascending.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListDbSystemsRequest.Builder sortOrder(ListDbSystemsRequest.SortOrder sortOrder)
The sort order to use (ASC or DESC).- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
limit
public ListDbSystemsRequest.Builder limit(Integer limit)
The maximum number of items to return in a paginated list call.For information about pagination, see List Pagination.
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListDbSystemsRequest.Builder page(String page)
The value of the opc-next-page or opc-prev-page response header from the previous list call.For information about pagination, see List Pagination.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListDbSystemsRequest.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 ListDbSystemsRequest.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 ListDbSystemsRequest.Builder copy(ListDbSystemsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListDbSystemsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListDbSystemsRequest build()
Build the instance of ListDbSystemsRequest 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<ListDbSystemsRequest,Void>
- Returns:
- instance of ListDbSystemsRequest
-
buildWithoutInvocationCallback
public ListDbSystemsRequest buildWithoutInvocationCallback()
Build the instance of ListDbSystemsRequest 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 ListDbSystemsRequest
-
-