com.oracle.bmc.database.requests

Class ListDatabasesRequest.Builder

java.lang.Object

com.oracle.bmc.database.requests.ListDatabasesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDatabasesRequest,Void>

Enclosing class:

ListDatabasesRequest

public static class ListDatabasesRequest.Builder
extends Object
implements BmcRequest.Builder<ListDatabasesRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListDatabasesRequest	build() Build the instance of ListDatabasesRequest as configured by this builder
ListDatabasesRequest	buildWithoutInvocationCallback() Build the instance of ListDatabasesRequest as configured by this builder
ListDatabasesRequest.Builder	compartmentId(String compartmentId) The compartment OCID.
ListDatabasesRequest.Builder	copy(ListDatabasesRequest o) Copy method to populate the builder with values from the given instance.
ListDatabasesRequest.Builder	dbHomeId(String dbHomeId) A Database Home OCID.
ListDatabasesRequest.Builder	dbName(String dbName) A filter to return only resources that match the entire database name given.
ListDatabasesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListDatabasesRequest.Builder	lifecycleState(DatabaseSummary.LifecycleState lifecycleState) A filter to return only resources that match the given lifecycle state exactly.
ListDatabasesRequest.Builder	limit(Integer limit) The maximum number of items to return per page.
ListDatabasesRequest.Builder	page(String page) The pagination token to continue listing from.
ListDatabasesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListDatabasesRequest.Builder	sortBy(ListDatabasesRequest.SortBy sortBy) The field to sort by.
ListDatabasesRequest.Builder	sortOrder(ListDatabasesRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListDatabasesRequest.Builder	systemId(String systemId) The OCID of the Exadata DB system that you want to filter the database results by.

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$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListDatabasesRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

dbHomeId

public ListDatabasesRequest.Builder dbHomeId(String dbHomeId)

A Database Home OCID.

Parameters:

dbHomeId - the value to set

Returns:

this builder instance

systemId

public ListDatabasesRequest.Builder systemId(String systemId)

The OCID of the Exadata DB system that you want to filter the database results by. Applies only to Exadata DB systems.

Parameters:

systemId - the value to set

Returns:

this builder instance

limit

public ListDatabasesRequest.Builder limit(Integer limit)

The maximum number of items to return per page.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListDatabasesRequest.Builder page(String page)

The pagination token to continue listing from.

Parameters:

page - the value to set

Returns:

this builder instance

sortBy

public ListDatabasesRequest.Builder sortBy(ListDatabasesRequest.SortBy sortBy)

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DBNAME is ascending. The DBNAME sort order is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListDatabasesRequest.Builder sortOrder(ListDatabasesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListDatabasesRequest.Builder lifecycleState(DatabaseSummary.LifecycleState lifecycleState)

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

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

dbName

public ListDatabasesRequest.Builder dbName(String dbName)

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

Parameters:

dbName - the value to set

Returns:

this builder instance

invocationCallback

public ListDatabasesRequest.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 ListDatabasesRequest.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 ListDatabasesRequest.Builder copy(ListDatabasesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListDatabasesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDatabasesRequest build()

Build the instance of ListDatabasesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListDatabasesRequest,Void>

Returns:

instance of ListDatabasesRequest

buildWithoutInvocationCallback

public ListDatabasesRequest buildWithoutInvocationCallback()

Build the instance of ListDatabasesRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListDatabasesRequest