com.oracle.bmc.core

Class BlockstoragePaginators

java.lang.Object

com.oracle.bmc.core.BlockstoragePaginators

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

Collection of helper methods that can be used to provide an Iterable interface to any list operations of Blockstorage 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
BlockstoragePaginators(Blockstorage client)

Method Summary

Modifier and Type	Method and Description
Iterable<VolumeBackupPolicyAssignment>	getVolumeBackupPolicyAssetAssignmentRecordIterator(GetVolumeBackupPolicyAssetAssignmentRequest request) Creates a new iterable which will iterate over the VolumeBackupPolicyAssignment objects contained in responses from the getVolumeBackupPolicyAssetAssignment operation.
Iterable<GetVolumeBackupPolicyAssetAssignmentResponse>	getVolumeBackupPolicyAssetAssignmentResponseIterator(GetVolumeBackupPolicyAssetAssignmentRequest request) Creates a new iterable which will iterate over the responses received from the getVolumeBackupPolicyAssetAssignment operation.
Iterable<BootVolumeBackup>	listBootVolumeBackupsRecordIterator(ListBootVolumeBackupsRequest request) Creates a new iterable which will iterate over the BootVolumeBackup objects contained in responses from the listBootVolumeBackups operation.
Iterable<ListBootVolumeBackupsResponse>	listBootVolumeBackupsResponseIterator(ListBootVolumeBackupsRequest request) Creates a new iterable which will iterate over the responses received from the listBootVolumeBackups operation.
Iterable<BootVolume>	listBootVolumesRecordIterator(ListBootVolumesRequest request) Creates a new iterable which will iterate over the BootVolume objects contained in responses from the listBootVolumes operation.
Iterable<ListBootVolumesResponse>	listBootVolumesResponseIterator(ListBootVolumesRequest request) Creates a new iterable which will iterate over the responses received from the listBootVolumes operation.
Iterable<VolumeBackupPolicy>	listVolumeBackupPoliciesRecordIterator(ListVolumeBackupPoliciesRequest request) Creates a new iterable which will iterate over the VolumeBackupPolicy objects contained in responses from the listVolumeBackupPolicies operation.
Iterable<ListVolumeBackupPoliciesResponse>	listVolumeBackupPoliciesResponseIterator(ListVolumeBackupPoliciesRequest request) Creates a new iterable which will iterate over the responses received from the listVolumeBackupPolicies operation.
Iterable<VolumeBackup>	listVolumeBackupsRecordIterator(ListVolumeBackupsRequest request) Creates a new iterable which will iterate over the VolumeBackup objects contained in responses from the listVolumeBackups operation.
Iterable<ListVolumeBackupsResponse>	listVolumeBackupsResponseIterator(ListVolumeBackupsRequest request) Creates a new iterable which will iterate over the responses received from the listVolumeBackups operation.
Iterable<VolumeGroupBackup>	listVolumeGroupBackupsRecordIterator(ListVolumeGroupBackupsRequest request) Creates a new iterable which will iterate over the VolumeGroupBackup objects contained in responses from the listVolumeGroupBackups operation.
Iterable<ListVolumeGroupBackupsResponse>	listVolumeGroupBackupsResponseIterator(ListVolumeGroupBackupsRequest request) Creates a new iterable which will iterate over the responses received from the listVolumeGroupBackups operation.
Iterable<VolumeGroup>	listVolumeGroupsRecordIterator(ListVolumeGroupsRequest request) Creates a new iterable which will iterate over the VolumeGroup objects contained in responses from the listVolumeGroups operation.
Iterable<ListVolumeGroupsResponse>	listVolumeGroupsResponseIterator(ListVolumeGroupsRequest request) Creates a new iterable which will iterate over the responses received from the listVolumeGroups operation.
Iterable<Volume>	listVolumesRecordIterator(ListVolumesRequest request) Creates a new iterable which will iterate over the Volume objects contained in responses from the listVolumes operation.
Iterable<ListVolumesResponse>	listVolumesResponseIterator(ListVolumesRequest request) Creates a new iterable which will iterate over the responses received from the listVolumes operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockstoragePaginators

@ConstructorProperties(value="client")
public BlockstoragePaginators(Blockstorage client)

Method Detail

getVolumeBackupPolicyAssetAssignmentResponseIterator

public Iterable<GetVolumeBackupPolicyAssetAssignmentResponse> getVolumeBackupPolicyAssetAssignmentResponseIterator(GetVolumeBackupPolicyAssetAssignmentRequest request)

Creates a new iterable which will iterate over the responses received from the getVolumeBackupPolicyAssetAssignment 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.

getVolumeBackupPolicyAssetAssignmentRecordIterator

public Iterable<VolumeBackupPolicyAssignment> getVolumeBackupPolicyAssetAssignmentRecordIterator(GetVolumeBackupPolicyAssetAssignmentRequest request)

Creates a new iterable which will iterate over the VolumeBackupPolicyAssignment objects contained in responses from the getVolumeBackupPolicyAssetAssignment 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 VolumeBackupPolicyAssignment objects contained in responses received from the service.

listBootVolumeBackupsResponseIterator

public Iterable<ListBootVolumeBackupsResponse> listBootVolumeBackupsResponseIterator(ListBootVolumeBackupsRequest request)

Creates a new iterable which will iterate over the responses received from the listBootVolumeBackups 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.

listBootVolumeBackupsRecordIterator

public Iterable<BootVolumeBackup> listBootVolumeBackupsRecordIterator(ListBootVolumeBackupsRequest request)

Creates a new iterable which will iterate over the BootVolumeBackup objects contained in responses from the listBootVolumeBackups 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 BootVolumeBackup objects contained in responses received from the service.

listBootVolumesResponseIterator

public Iterable<ListBootVolumesResponse> listBootVolumesResponseIterator(ListBootVolumesRequest request)

Creates a new iterable which will iterate over the responses received from the listBootVolumes 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.

listBootVolumesRecordIterator

public Iterable<BootVolume> listBootVolumesRecordIterator(ListBootVolumesRequest request)

Creates a new iterable which will iterate over the BootVolume objects contained in responses from the listBootVolumes 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 BootVolume objects contained in responses received from the service.

listVolumeBackupPoliciesResponseIterator

public Iterable<ListVolumeBackupPoliciesResponse> listVolumeBackupPoliciesResponseIterator(ListVolumeBackupPoliciesRequest request)

Creates a new iterable which will iterate over the responses received from the listVolumeBackupPolicies 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.

listVolumeBackupPoliciesRecordIterator

public Iterable<VolumeBackupPolicy> listVolumeBackupPoliciesRecordIterator(ListVolumeBackupPoliciesRequest request)

Creates a new iterable which will iterate over the VolumeBackupPolicy objects contained in responses from the listVolumeBackupPolicies 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 VolumeBackupPolicy objects contained in responses received from the service.

listVolumeBackupsResponseIterator

public Iterable<ListVolumeBackupsResponse> listVolumeBackupsResponseIterator(ListVolumeBackupsRequest request)

Creates a new iterable which will iterate over the responses received from the listVolumeBackups 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.

listVolumeBackupsRecordIterator

public Iterable<VolumeBackup> listVolumeBackupsRecordIterator(ListVolumeBackupsRequest request)

Creates a new iterable which will iterate over the VolumeBackup objects contained in responses from the listVolumeBackups 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 VolumeBackup objects contained in responses received from the service.

listVolumeGroupBackupsResponseIterator

public Iterable<ListVolumeGroupBackupsResponse> listVolumeGroupBackupsResponseIterator(ListVolumeGroupBackupsRequest request)

Creates a new iterable which will iterate over the responses received from the listVolumeGroupBackups 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.

listVolumeGroupBackupsRecordIterator

public Iterable<VolumeGroupBackup> listVolumeGroupBackupsRecordIterator(ListVolumeGroupBackupsRequest request)

Creates a new iterable which will iterate over the VolumeGroupBackup objects contained in responses from the listVolumeGroupBackups 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 VolumeGroupBackup objects contained in responses received from the service.

listVolumeGroupsResponseIterator

public Iterable<ListVolumeGroupsResponse> listVolumeGroupsResponseIterator(ListVolumeGroupsRequest request)

Creates a new iterable which will iterate over the responses received from the listVolumeGroups 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.

listVolumeGroupsRecordIterator

public Iterable<VolumeGroup> listVolumeGroupsRecordIterator(ListVolumeGroupsRequest request)

Creates a new iterable which will iterate over the VolumeGroup objects contained in responses from the listVolumeGroups 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 VolumeGroup objects contained in responses received from the service.

listVolumesResponseIterator

public Iterable<ListVolumesResponse> listVolumesResponseIterator(ListVolumesRequest request)

Creates a new iterable which will iterate over the responses received from the listVolumes 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.

listVolumesRecordIterator

public Iterable<Volume> listVolumesRecordIterator(ListVolumesRequest request)

Creates a new iterable which will iterate over the Volume objects contained in responses from the listVolumes 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 Volume objects contained in responses received from the service.