com.oracle.bmc.cloudbridge.requests

Class ListAgentsRequest.Builder

java.lang.Object

com.oracle.bmc.cloudbridge.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>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListAgentsRequest.Builder	agentId(String agentId) A filter to return only resources that match the given Agent ID.
ListAgentsRequest	build() Build the instance of ListAgentsRequest as configured by this builder
ListAgentsRequest	buildWithoutInvocationCallback() Build the instance of ListAgentsRequest as configured by this builder
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	environmentId(String environmentId) A filter to return only resources that match the given environment ID.
ListAgentsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListAgentsRequest.Builder	lifecycleState(Agent.LifecycleState lifecycleState) A filter to return only resources their lifecycleState matches the given lifecycleState.
ListAgentsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListAgentsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListAgentsRequest.Builder	page(String page) A token representing the position 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’.

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

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

environmentId

public ListAgentsRequest.Builder environmentId(String environmentId)

A filter to return only resources that match the given environment ID.

Parameters:

environmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListAgentsRequest.Builder lifecycleState(Agent.LifecycleState lifecycleState)

A filter to return only resources their lifecycleState matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListAgentsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

agentId

public ListAgentsRequest.Builder agentId(String agentId)

A filter to return only resources that match the given Agent ID.

Parameters:

agentId - the value to set

Returns:

this builder instance

limit

public ListAgentsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListAgentsRequest.Builder page(String page)

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListAgentsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use, either ‘ASC’ or ‘DESC’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListAgentsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

Returns:

instance of ListAgentsRequest

buildWithoutInvocationCallback

public ListAgentsRequest buildWithoutInvocationCallback()

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