Package com.oracle.bmc.filestorage.requests

Class ListExportsRequest.Builder

java.lang.Object

com.oracle.bmc.filestorage.requests.ListExportsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListExportsRequest,Void>

Enclosing class:

ListExportsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListExportsRequest	build()	Build the instance of ListExportsRequest as configured by this builder
ListExportsRequest	buildWithoutInvocationCallback()	Build the instance of ListExportsRequest as configured by this builder
ListExportsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListExportsRequest.Builder	copy(ListExportsRequest o)	Copy method to populate the builder with values from the given instance.
ListExportsRequest.Builder	exportSetId(String exportSetId)	The OCID of the export set.
ListExportsRequest.Builder	fileSystemId(String fileSystemId)	The OCID of the file system.
ListExportsRequest.Builder	id(String id)	Filter results by OCID.
ListExportsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListExportsRequest.Builder	lifecycleState(ListExportsRequest.LifecycleState lifecycleState)	Filter results by the specified lifecycle state.
ListExportsRequest.Builder	limit(Integer limit)	For list pagination.
ListExportsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListExportsRequest.Builder	page(String page)	For list pagination.
ListExportsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListExportsRequest.Builder	sortBy(ListExportsRequest.SortBy sortBy)	The field to sort by.
ListExportsRequest.Builder	sortOrder(ListExportsRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is 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 ListExportsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListExportsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 4096 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: 500

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListExportsRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call.

For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Parameters:

page - the value to set

Returns:

this builder instance

exportSetId

public ListExportsRequest.Builder exportSetId(String exportSetId)

The OCID of the export set.

Parameters:

exportSetId - the value to set

Returns:

this builder instance

fileSystemId

public ListExportsRequest.Builder fileSystemId(String fileSystemId)

The OCID of the file system.

Parameters:

fileSystemId - the value to set

Returns:

this builder instance

lifecycleState

public ListExportsRequest.Builder lifecycleState(ListExportsRequest.LifecycleState lifecycleState)

Filter results by the specified lifecycle state.

Must be a valid state for the resource type.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

id

public ListExportsRequest.Builder id(String id)

Filter results by OCID.

Must be an OCID of the correct type for the resouce type.

Parameters:

id - the value to set

Returns:

this builder instance

sortBy

public ListExportsRequest.Builder sortBy(ListExportsRequest.SortBy sortBy)

The field to sort by.

You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by path, results are shown in ascending alphanumeric order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListExportsRequest.Builder sortOrder(ListExportsRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.

The default order is ‘desc’ except for numeric values.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListExportsRequest.Builder opcRequestId(String opcRequestId)

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

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

Specified by:

copy in interface BmcRequest.Builder<ListExportsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListExportsRequest build()

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

Returns:

instance of ListExportsRequest

buildWithoutInvocationCallback

public ListExportsRequest buildWithoutInvocationCallback()

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