Package com.oracle.bmc.dataintegration.requests

Class ListWorkspacesRequest.Builder

java.lang.Object

com.oracle.bmc.dataintegration.requests.ListWorkspacesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListWorkspacesRequest,Void>

Enclosing class:

ListWorkspacesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListWorkspacesRequest	build()	Build the instance of ListWorkspacesRequest as configured by this builder
ListWorkspacesRequest	buildWithoutInvocationCallback()	Build the instance of ListWorkspacesRequest as configured by this builder
ListWorkspacesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment containing the resources you want to list.
ListWorkspacesRequest.Builder	copy(ListWorkspacesRequest o)	Copy method to populate the builder with values from the given instance.
ListWorkspacesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListWorkspacesRequest.Builder	lifecycleState(Workspace.LifecycleState lifecycleState)	The lifecycle state of a resource.
ListWorkspacesRequest.Builder	limit(Integer limit)	Sets the maximum number of results per page, or items to return in a paginated List call.
ListWorkspacesRequest.Builder	name(String name)	Used to filter by the name of the object.
ListWorkspacesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListWorkspacesRequest.Builder	page(String page)	For list pagination.
ListWorkspacesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListWorkspacesRequest.Builder	sortBy(ListWorkspacesRequest.SortBy sortBy)	Specifies the field to sort by.
ListWorkspacesRequest.Builder	sortOrder(ListWorkspacesRequest.SortOrder sortOrder)	Specifies sort order to use, either ASC (ascending) or DESC (descending).

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

The OCID of the compartment containing the resources you want to list.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListWorkspacesRequest.Builder name(String name)

Used to filter by the name of the object.

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListWorkspacesRequest.Builder limit(Integer limit)

Sets the maximum number of results per page, or items to return in a paginated List call.

See List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListWorkspacesRequest.Builder page(String page)

For list pagination.

The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

lifecycleState

public ListWorkspacesRequest.Builder lifecycleState(Workspace.LifecycleState lifecycleState)

The lifecycle state of a resource.

When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortOrder

public ListWorkspacesRequest.Builder sortOrder(ListWorkspacesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListWorkspacesRequest.Builder sortBy(ListWorkspacesRequest.SortBy sortBy)

Specifies the field to sort by.

Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListWorkspacesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListWorkspacesRequest build()

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

Returns:

instance of ListWorkspacesRequest

buildWithoutInvocationCallback

public ListWorkspacesRequest buildWithoutInvocationCallback()

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