com.oracle.bmc.database.requests

Class ListDbHomesRequest.Builder

java.lang.Object

com.oracle.bmc.database.requests.ListDbHomesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDbHomesRequest,Void>

Enclosing class:

ListDbHomesRequest

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

Method Summary

Modifier and Type	Method and Description
ListDbHomesRequest.Builder	backupId(String backupId) The OCID of the backup.
ListDbHomesRequest	build() Build the instance of ListDbHomesRequest as configured by this builder
ListDbHomesRequest	buildWithoutInvocationCallback()
ListDbHomesRequest.Builder	compartmentId(String compartmentId) The compartment OCID.
ListDbHomesRequest.Builder	copy(ListDbHomesRequest o) Copy method to populate the builder with values from the given instance.
ListDbHomesRequest.Builder	dbSystemId(String dbSystemId) The DB system OCID.
ListDbHomesRequest.Builder	dbVersion(String dbVersion) A filter to return only DB Homes that match the specified dbVersion.
ListDbHomesRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire display name given.
ListDbHomesRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListDbHomesRequest.Builder	lifecycleState(DbHomeSummary.LifecycleState lifecycleState) A filter to return only resources that match the given lifecycle state exactly.
ListDbHomesRequest.Builder	limit(Integer limit) The maximum number of items to return per page.
ListDbHomesRequest.Builder	page(String page) The pagination token to continue listing from.
ListDbHomesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListDbHomesRequest.Builder	sortBy(ListDbHomesRequest.SortBy sortBy) The field to sort by.
ListDbHomesRequest.Builder	sortOrder(ListDbHomesRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
String	toString()
ListDbHomesRequest.Builder	vmClusterId(String vmClusterId) The OCID of the VM cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Method Detail

invocationCallback

public ListDbHomesRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListDbHomesRequest.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 ListDbHomesRequest.Builder copy(ListDbHomesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListDbHomesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDbHomesRequest build()

Build the instance of ListDbHomesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListDbHomesRequest,Void>

Returns:

instance of ListDbHomesRequest

compartmentId

public ListDbHomesRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Returns:

this.

dbSystemId

public ListDbHomesRequest.Builder dbSystemId(String dbSystemId)

The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

Returns:

this.

vmClusterId

public ListDbHomesRequest.Builder vmClusterId(String vmClusterId)

The OCID of the VM cluster.

Returns:

this.

backupId

public ListDbHomesRequest.Builder backupId(String backupId)

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.

Returns:

this.

dbVersion

public ListDbHomesRequest.Builder dbVersion(String dbVersion)

A filter to return only DB Homes that match the specified dbVersion.

Returns:

this.

limit

public ListDbHomesRequest.Builder limit(Integer limit)

The maximum number of items to return per page.

Returns:

this.

page

public ListDbHomesRequest.Builder page(String page)

The pagination token to continue listing from.

Returns:

this.

sortBy

public ListDbHomesRequest.Builder sortBy(ListDbHomesRequest.SortBy sortBy)

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.

Returns:

this.

sortOrder

public ListDbHomesRequest.Builder sortOrder(ListDbHomesRequest.SortOrder sortOrder)

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

Returns:

this.

lifecycleState

public ListDbHomesRequest.Builder lifecycleState(DbHomeSummary.LifecycleState lifecycleState)

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

Returns:

this.

displayName

public ListDbHomesRequest.Builder displayName(String displayName)

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

Returns:

this.

buildWithoutInvocationCallback

public ListDbHomesRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object