Package com.oracle.bmc.generativeaisandbox.requests

Class ListSandboxesRequest.Builder

java.lang.Object

com.oracle.bmc.generativeaisandbox.requests.ListSandboxesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSandboxesRequest,Void>

Enclosing class:

ListSandboxesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSandboxesRequest	build()	Build the instance of ListSandboxesRequest as configured by this builder
ListSandboxesRequest	buildWithoutInvocationCallback()	Build the instance of ListSandboxesRequest as configured by this builder
ListSandboxesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListSandboxesRequest.Builder	copy(ListSandboxesRequest o)	Copy method to populate the builder with values from the given instance.
ListSandboxesRequest.Builder	displayName(String displayName)	Sandbox display name used to filter listed sandbox resources.
ListSandboxesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSandboxesRequest.Builder	lifecycleState(Sandbox.LifecycleState lifecycleState)	A filter to return only resources whose state matches the given state.
ListSandboxesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListSandboxesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListSandboxesRequest.Builder	page(String page)	A token representing the position at which to start retrieving results.
ListSandboxesRequest.Builder	projectId(String projectId)	The project identifier used to filter listed sandbox resources.
ListSandboxesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSandboxesRequest.Builder	sandboxId(String sandboxId)	Sandbox identifier used to filter listed sandbox resources.
ListSandboxesRequest.Builder	sortBy(ListSandboxesRequest.SortBy sortBy)	The field to sort by.
ListSandboxesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (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

opcRequestId

public ListSandboxesRequest.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. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

projectId

public ListSandboxesRequest.Builder projectId(String projectId)

The project identifier used to filter listed sandbox resources.

Parameters:

projectId - the value to set

Returns:

this builder instance

compartmentId

public ListSandboxesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

sandboxId

public ListSandboxesRequest.Builder sandboxId(String sandboxId)

Sandbox identifier used to filter listed sandbox resources.

Newly generated Sandbox IDs use sbx- followed by 16 lowercase base32 characters (a-z2-7); existing legacy IDs remain accepted.

Parameters:

sandboxId - the value to set

Returns:

this builder instance

displayName

public ListSandboxesRequest.Builder displayName(String displayName)

Sandbox display name used to filter listed sandbox resources.

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListSandboxesRequest.Builder lifecycleState(Sandbox.LifecycleState lifecycleState)

A filter to return only resources whose state matches the given state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortBy

public ListSandboxesRequest.Builder sortBy(ListSandboxesRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is ascending.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListSandboxesRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListSandboxesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSandboxesRequest.Builder page(String page)

A token representing the position at which to start retrieving results.

Parameters:

page - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSandboxesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSandboxesRequest build()

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

Returns:

instance of ListSandboxesRequest

buildWithoutInvocationCallback

public ListSandboxesRequest buildWithoutInvocationCallback()

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