Package com.oracle.bmc.lockbox.requests

Class ListLockboxesRequest.Builder

java.lang.Object

com.oracle.bmc.lockbox.requests.ListLockboxesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListLockboxesRequest,Void>

Enclosing class:

ListLockboxesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListLockboxesRequest	build()	Build the instance of ListLockboxesRequest as configured by this builder
ListLockboxesRequest	buildWithoutInvocationCallback()	Build the instance of ListLockboxesRequest as configured by this builder
ListLockboxesRequest.Builder	compartmentId(String compartmentId)	The ID of the compartment in which to list resources.
ListLockboxesRequest.Builder	copy(ListLockboxesRequest o)	Copy method to populate the builder with values from the given instance.
ListLockboxesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListLockboxesRequest.Builder	id(String id)	unique Lockbox identifier
ListLockboxesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListLockboxesRequest.Builder	lifecycleState(Lockbox.LifecycleState lifecycleState)	A filter to return only resources their lifecycleState matches the given lifecycleState.
ListLockboxesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListLockboxesRequest.Builder	lockboxPartner(LockboxPartner lockboxPartner)	The name of the lockbox partner.
ListLockboxesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListLockboxesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListLockboxesRequest.Builder	partnerId(String partnerId)	The ID of the partner.
ListLockboxesRequest.Builder	resourceId(String resourceId)	The ID of the resource associated with the lockbox.
ListLockboxesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListLockboxesRequest.Builder	sortBy(ListLockboxesRequest.SortBy sortBy)	The field to sort by.
ListLockboxesRequest.Builder	sortOrder(SortOrder 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 ListLockboxesRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListLockboxesRequest.Builder lifecycleState(Lockbox.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 ListLockboxesRequest.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

id

public ListLockboxesRequest.Builder id(String id)

unique Lockbox identifier

Parameters:

id - the value to set

Returns:

this builder instance

resourceId

public ListLockboxesRequest.Builder resourceId(String resourceId)

The ID of the resource associated with the lockbox.

Parameters:

resourceId - the value to set

Returns:

this builder instance

lockboxPartner

public ListLockboxesRequest.Builder lockboxPartner(LockboxPartner lockboxPartner)

The name of the lockbox partner.

Parameters:

lockboxPartner - the value to set

Returns:

this builder instance

partnerId

public ListLockboxesRequest.Builder partnerId(String partnerId)

The ID of the partner.

Parameters:

partnerId - the value to set

Returns:

this builder instance

limit

public ListLockboxesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListLockboxesRequest.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 ListLockboxesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListLockboxesRequest.Builder sortBy(ListLockboxesRequest.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 ListLockboxesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListLockboxesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListLockboxesRequest build()

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

Returns:

instance of ListLockboxesRequest

buildWithoutInvocationCallback

public ListLockboxesRequest buildWithoutInvocationCallback()

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