com.oracle.bmc.filestorage

Class FileStoragePaginators

java.lang.Object

com.oracle.bmc.filestorage.FileStoragePaginators

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public class FileStoragePaginators
extends Object

Collection of helper methods that can be used to provide an Iterable interface to any list operations of FileStorage where multiple pages of data may be fetched. Two styles of iteration are supported:

• Iterating over the Response objects returned by the list operation. These are referred to as ResponseIterators, and the methods are suffixed with ResponseIterator. For example: listUsersResponseIterator
• Iterating over the resources/records being listed. These are referred to as RecordIterators, and the methods are suffixed with RecordIterator. For example: listUsersRecordIterator

These iterables abstract away the need to write code to manually handle pagination via looping and using the page tokens. They will automatically fetch more data from the service when required.

As an example, if we were using the ListUsers operation in IdentityService, then the Iterable returned by calling a ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the Iterable returned by calling a RecordIterator method would iterate over the User records and we don’t have to deal with ListUsersResponse objects at all. In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.

Constructor Summary

Constructors

Constructor and Description
FileStoragePaginators(FileStorage client)

Method Summary

Modifier and Type	Method and Description
Iterable<ExportSetSummary>	listExportSetsRecordIterator(ListExportSetsRequest request) Creates a new iterable which will iterate over the ExportSetSummary objects contained in responses from the listExportSets operation.
Iterable<ListExportSetsResponse>	listExportSetsResponseIterator(ListExportSetsRequest request) Creates a new iterable which will iterate over the responses received from the listExportSets operation.
Iterable<ExportSummary>	listExportsRecordIterator(ListExportsRequest request) Creates a new iterable which will iterate over the ExportSummary objects contained in responses from the listExports operation.
Iterable<ListExportsResponse>	listExportsResponseIterator(ListExportsRequest request) Creates a new iterable which will iterate over the responses received from the listExports operation.
Iterable<FileSystemSummary>	listFileSystemsRecordIterator(ListFileSystemsRequest request) Creates a new iterable which will iterate over the FileSystemSummary objects contained in responses from the listFileSystems operation.
Iterable<ListFileSystemsResponse>	listFileSystemsResponseIterator(ListFileSystemsRequest request) Creates a new iterable which will iterate over the responses received from the listFileSystems operation.
Iterable<MountTargetSummary>	listMountTargetsRecordIterator(ListMountTargetsRequest request) Creates a new iterable which will iterate over the MountTargetSummary objects contained in responses from the listMountTargets operation.
Iterable<ListMountTargetsResponse>	listMountTargetsResponseIterator(ListMountTargetsRequest request) Creates a new iterable which will iterate over the responses received from the listMountTargets operation.
Iterable<SnapshotSummary>	listSnapshotsRecordIterator(ListSnapshotsRequest request) Creates a new iterable which will iterate over the SnapshotSummary objects contained in responses from the listSnapshots operation.
Iterable<ListSnapshotsResponse>	listSnapshotsResponseIterator(ListSnapshotsRequest request) Creates a new iterable which will iterate over the responses received from the listSnapshots operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileStoragePaginators

@ConstructorProperties(value="client")
public FileStoragePaginators(FileStorage client)

Method Detail

listExportSetsResponseIterator

public Iterable<ListExportSetsResponse> listExportSetsResponseIterator(ListExportSetsRequest request)

Creates a new iterable which will iterate over the responses received from the listExportSets operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listExportSetsRecordIterator

public Iterable<ExportSetSummary> listExportSetsRecordIterator(ListExportSetsRequest request)

Creates a new iterable which will iterate over the ExportSetSummary objects contained in responses from the listExportSets operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the ExportSetSummary objects contained in responses received from the service.

listExportsResponseIterator

public Iterable<ListExportsResponse> listExportsResponseIterator(ListExportsRequest request)

Creates a new iterable which will iterate over the responses received from the listExports operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listExportsRecordIterator

public Iterable<ExportSummary> listExportsRecordIterator(ListExportsRequest request)

Creates a new iterable which will iterate over the ExportSummary objects contained in responses from the listExports operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the ExportSummary objects contained in responses received from the service.

listFileSystemsResponseIterator

public Iterable<ListFileSystemsResponse> listFileSystemsResponseIterator(ListFileSystemsRequest request)

Creates a new iterable which will iterate over the responses received from the listFileSystems operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listFileSystemsRecordIterator

public Iterable<FileSystemSummary> listFileSystemsRecordIterator(ListFileSystemsRequest request)

Creates a new iterable which will iterate over the FileSystemSummary objects contained in responses from the listFileSystems operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the FileSystemSummary objects contained in responses received from the service.

listMountTargetsResponseIterator

public Iterable<ListMountTargetsResponse> listMountTargetsResponseIterator(ListMountTargetsRequest request)

Creates a new iterable which will iterate over the responses received from the listMountTargets operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listMountTargetsRecordIterator

public Iterable<MountTargetSummary> listMountTargetsRecordIterator(ListMountTargetsRequest request)

Creates a new iterable which will iterate over the MountTargetSummary objects contained in responses from the listMountTargets operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the MountTargetSummary objects contained in responses received from the service.

listSnapshotsResponseIterator

public Iterable<ListSnapshotsResponse> listSnapshotsResponseIterator(ListSnapshotsRequest request)

Creates a new iterable which will iterate over the responses received from the listSnapshots operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the responses received from the service.

listSnapshotsRecordIterator

public Iterable<SnapshotSummary> listSnapshotsRecordIterator(ListSnapshotsRequest request)

Creates a new iterable which will iterate over the SnapshotSummary objects contained in responses from the listSnapshots operation. This iterable will fetch more data from the server as needed.

Parameters:

request - a request which can be sent to the service operation

Returns:

an Iterable which can be used to iterate over the SnapshotSummary objects contained in responses received from the service.