Package com.oracle.bmc.databasemanagement.requests

Class ListExternalDatabasesRequest.Builder

java.lang.Object

com.oracle.bmc.databasemanagement.requests.ListExternalDatabasesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListExternalDatabasesRequest,Void>

Enclosing class:

ListExternalDatabasesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListExternalDatabasesRequest	build()	Build the instance of ListExternalDatabasesRequest as configured by this builder
ListExternalDatabasesRequest	buildWithoutInvocationCallback()	Build the instance of ListExternalDatabasesRequest as configured by this builder
ListExternalDatabasesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListExternalDatabasesRequest.Builder	copy(ListExternalDatabasesRequest o)	Copy method to populate the builder with values from the given instance.
ListExternalDatabasesRequest.Builder	displayName(String displayName)	A filter to only return the resources that match the entire display name.
ListExternalDatabasesRequest.Builder	externalDatabaseId(String externalDatabaseId)	The OCID of the external database.
ListExternalDatabasesRequest.Builder	externalDbSystemId(String externalDbSystemId)	The OCID of the external DB system.
ListExternalDatabasesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListExternalDatabasesRequest.Builder	limit(Integer limit)	The maximum number of records returned in the paginated response.
ListExternalDatabasesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListExternalDatabasesRequest.Builder	page(String page)	The page token representing the page from where the next set of paginated results are retrieved.
ListExternalDatabasesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListExternalDatabasesRequest.Builder	sortBy(ListExternalDatabasesRequest.SortBy sortBy)	The field to sort information by.
ListExternalDatabasesRequest.Builder	sortOrder(SortOrders sortOrder)	The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order.

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 ListExternalDatabasesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

externalDbSystemId

public ListExternalDatabasesRequest.Builder externalDbSystemId(String externalDbSystemId)

The OCID of the external DB system.

Parameters:

externalDbSystemId - the value to set

Returns:

this builder instance

externalDatabaseId

public ListExternalDatabasesRequest.Builder externalDatabaseId(String externalDatabaseId)

The OCID of the external database.

Parameters:

externalDatabaseId - the value to set

Returns:

this builder instance

displayName

public ListExternalDatabasesRequest.Builder displayName(String displayName)

A filter to only return the resources that match the entire display name.

Parameters:

displayName - the value to set

Returns:

this builder instance

page

public ListExternalDatabasesRequest.Builder page(String page)

The page token representing the page from where the next set of paginated results are retrieved.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListExternalDatabasesRequest.Builder limit(Integer limit)

The maximum number of records returned in the paginated response.

Parameters:

limit - the value to set

Returns:

this builder instance

sortBy

public ListExternalDatabasesRequest.Builder sortBy(ListExternalDatabasesRequest.SortBy sortBy)

The field to sort information by.

Only one sortOrder can be used. The default sort order for TIMECREATED is descending and the default sort order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case-sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListExternalDatabasesRequest.Builder sortOrder(SortOrders sortOrder)

The option to sort information in ascending (\u2018ASC\u2019) or descending (\u2018DESC\u2019) order.

Ascending order is the default order.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListExternalDatabasesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListExternalDatabasesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListExternalDatabasesRequest build()

Build the instance of ListExternalDatabasesRequest 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<ListExternalDatabasesRequest,Void>

Returns:

instance of ListExternalDatabasesRequest

buildWithoutInvocationCallback

public ListExternalDatabasesRequest buildWithoutInvocationCallback()

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