Package com.oracle.bmc.filestorage.requests

Class ListSnapshotsRequest.Builder

java.lang.Object

com.oracle.bmc.filestorage.requests.ListSnapshotsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSnapshotsRequest,Void>

Enclosing class:

ListSnapshotsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSnapshotsRequest	build()	Build the instance of ListSnapshotsRequest as configured by this builder
ListSnapshotsRequest	buildWithoutInvocationCallback()	Build the instance of ListSnapshotsRequest as configured by this builder
ListSnapshotsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListSnapshotsRequest.Builder	copy(ListSnapshotsRequest o)	Copy method to populate the builder with values from the given instance.
ListSnapshotsRequest.Builder	fileSystemId(String fileSystemId)	The OCID of the file system.
ListSnapshotsRequest.Builder	filesystemSnapshotPolicyId(String filesystemSnapshotPolicyId)	The OCID of the file system snapshot policy that is used to create the snapshots.
ListSnapshotsRequest.Builder	id(String id)	Filter results by OCID.
ListSnapshotsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSnapshotsRequest.Builder	lifecycleState(ListSnapshotsRequest.LifecycleState lifecycleState)	Filter results by the specified lifecycle state.
ListSnapshotsRequest.Builder	limit(Integer limit)	For list pagination.
ListSnapshotsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListSnapshotsRequest.Builder	page(String page)	For list pagination.
ListSnapshotsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSnapshotsRequest.Builder	sortOrder(ListSnapshotsRequest.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

limit

public ListSnapshotsRequest.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, 100 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: 100

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

lifecycleState

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

filesystemSnapshotPolicyId

public ListSnapshotsRequest.Builder filesystemSnapshotPolicyId(String filesystemSnapshotPolicyId)

The OCID of the file system snapshot policy that is used to create the snapshots.

Parameters:

filesystemSnapshotPolicyId - the value to set

Returns:

this builder instance

compartmentId

public ListSnapshotsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

fileSystemId

public ListSnapshotsRequest.Builder fileSystemId(String fileSystemId)

The OCID of the file system.

Parameters:

fileSystemId - the value to set

Returns:

this builder instance

sortOrder

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSnapshotsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSnapshotsRequest build()

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

Returns:

instance of ListSnapshotsRequest

buildWithoutInvocationCallback

public ListSnapshotsRequest buildWithoutInvocationCallback()

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