com.oracle.bmc.mysql.requests

Class ListReplicasRequest.Builder

java.lang.Object

com.oracle.bmc.mysql.requests.ListReplicasRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListReplicasRequest,Void>

Enclosing class:

ListReplicasRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListReplicasRequest	build() Build the instance of ListReplicasRequest as configured by this builder
ListReplicasRequest	buildWithoutInvocationCallback() Build the instance of ListReplicasRequest as configured by this builder
ListReplicasRequest.Builder	compartmentId(String compartmentId) The compartment OCID.
ListReplicasRequest.Builder	configurationId(String configurationId) The requested Configuration instance.
ListReplicasRequest.Builder	copy(ListReplicasRequest o) Copy method to populate the builder with values from the given instance.
ListReplicasRequest.Builder	dbSystemId(String dbSystemId) The DB System OCID.
ListReplicasRequest.Builder	displayName(String displayName) A filter to return only the resource matching the given display name exactly.
ListReplicasRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListReplicasRequest.Builder	isUpToDate(Boolean isUpToDate) Filter instances if they are using the latest revision of the Configuration they are associated with.
ListReplicasRequest.Builder	lifecycleState(ReplicaSummary.LifecycleState lifecycleState) The LifecycleState of the read replica.
ListReplicasRequest.Builder	limit(Integer limit) The maximum number of items to return in a paginated list call.
ListReplicasRequest.Builder	opcRequestId(String opcRequestId) Customer-defined unique identifier for the request.
ListReplicasRequest.Builder	page(String page) The value of the opc-next-page or opc-prev-page response header from the previous list call.
ListReplicasRequest.Builder	replicaId(String replicaId) The read replica OCID.
ListReplicasRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListReplicasRequest.Builder	sortBy(ListReplicasRequest.SortBy sortBy) The field to sort by.
ListReplicasRequest.Builder	sortOrder(ListReplicasRequest.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$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListReplicasRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListReplicasRequest.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

limit

public ListReplicasRequest.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 ListReplicasRequest.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

displayName

public ListReplicasRequest.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

dbSystemId

public ListReplicasRequest.Builder dbSystemId(String dbSystemId)

The DB System OCID.

Parameters:

dbSystemId - the value to set

Returns:

this builder instance

lifecycleState

public ListReplicasRequest.Builder lifecycleState(ReplicaSummary.LifecycleState lifecycleState)

The LifecycleState of the read replica.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

replicaId

public ListReplicasRequest.Builder replicaId(String replicaId)

The read replica OCID.

Parameters:

replicaId - the value to set

Returns:

this builder instance

configurationId

public ListReplicasRequest.Builder configurationId(String configurationId)

The requested Configuration instance.

Parameters:

configurationId - the value to set

Returns:

this builder instance

isUpToDate

public ListReplicasRequest.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

sortBy

public ListReplicasRequest.Builder sortBy(ListReplicasRequest.SortBy sortBy)

The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListReplicasRequest.Builder sortOrder(ListReplicasRequest.SortOrder sortOrder)

The sort order to use (ASC or DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListReplicasRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListReplicasRequest build()

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

Returns:

instance of ListReplicasRequest

buildWithoutInvocationCallback

public ListReplicasRequest buildWithoutInvocationCallback()

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