com.oracle.bmc.databasemigration.requests

Class ListAgentsRequest.Builder

java.lang.Object

com.oracle.bmc.databasemigration.requests.ListAgentsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAgentsRequest,Void>

Enclosing class:

ListAgentsRequest

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

Method Summary

Modifier and Type	Method and Description
ListAgentsRequest	build() Build the instance of ListAgentsRequest as configured by this builder
ListAgentsRequest	buildWithoutInvocationCallback()
ListAgentsRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list resources.
ListAgentsRequest.Builder	copy(ListAgentsRequest o) Copy method to populate the builder with values from the given instance.
ListAgentsRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire display name given.
ListAgentsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListAgentsRequest.Builder	lifecycleState(LifecycleStates lifecycleState) The current state of the Database Migration Deployment.
ListAgentsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListAgentsRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListAgentsRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListAgentsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListAgentsRequest.Builder	sortBy(ListAgentsRequest.SortBy sortBy) The field to sort by.
ListAgentsRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ‘asc’ or ‘desc’.
String	toString()

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

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

Specified by:

copy in interface BmcRequest.Builder<ListAgentsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAgentsRequest build()

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

Returns:

instance of ListAgentsRequest

compartmentId

public ListAgentsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Returns:

this.

limit

public ListAgentsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Returns:

this.

page

public ListAgentsRequest.Builder page(String page)

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Returns:

this.

sortBy

public ListAgentsRequest.Builder sortBy(ListAgentsRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Returns:

this.

sortOrder

public ListAgentsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Returns:

this.

displayName

public ListAgentsRequest.Builder displayName(String displayName)

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

Returns:

this.

lifecycleState

public ListAgentsRequest.Builder lifecycleState(LifecycleStates lifecycleState)

The current state of the Database Migration Deployment.

Returns:

this.

opcRequestId

public ListAgentsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

this.

buildWithoutInvocationCallback

public ListAgentsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object