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>

Constructor Summary

Constructors

Constructor and Description
Builder()

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() Build the instance of ListDbHomesRequest as configured by this builder
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(com.oracle.bmc.http.client.RequestInterceptor 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).
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, toString, wait, wait, wait

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

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListDbHomesRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

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.

Parameters:

dbSystemId - the value to set

Returns:

this builder instance

vmClusterId

public ListDbHomesRequest.Builder vmClusterId(String vmClusterId)

The OCID of the VM cluster.

Parameters:

vmClusterId - the value to set

Returns:

this builder instance

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.

Parameters:

backupId - the value to set

Returns:

this builder instance

dbVersion

public ListDbHomesRequest.Builder dbVersion(String dbVersion)

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

Parameters:

dbVersion - the value to set

Returns:

this builder instance

limit

public ListDbHomesRequest.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 ListDbHomesRequest.Builder page(String page)

The pagination token to continue listing from.

Parameters:

page - the value to set

Returns:

this builder instance

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListDbHomesRequest.Builder sortOrder(ListDbHomesRequest.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 ListDbHomesRequest.Builder lifecycleState(DbHomeSummary.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

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.

Parameters:

displayName - the value to set

Returns:

this builder instance

invocationCallback

public ListDbHomesRequest.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 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.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<ListDbHomesRequest,Void>

Returns:

instance of ListDbHomesRequest

buildWithoutInvocationCallback

public ListDbHomesRequest buildWithoutInvocationCallback()

Build the instance of ListDbHomesRequest 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 ListDbHomesRequest