com.oracle.bmc.objectstorage

Class ObjectStoragePaginators

java.lang.Object

com.oracle.bmc.objectstorage.ObjectStoragePaginators

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

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

Method Summary

Modifier and Type	Method and Description
Iterable<BucketSummary>	listBucketsRecordIterator(ListBucketsRequest request) Creates a new iterable which will iterate over the BucketSummary objects contained in responses from the listBuckets operation.
Iterable<ListBucketsResponse>	listBucketsResponseIterator(ListBucketsRequest request) Creates a new iterable which will iterate over the responses received from the listBuckets operation.
Iterable<MultipartUploadPartSummary>	listMultipartUploadPartsRecordIterator(ListMultipartUploadPartsRequest request) Creates a new iterable which will iterate over the MultipartUploadPartSummary objects contained in responses from the listMultipartUploadParts operation.
Iterable<ListMultipartUploadPartsResponse>	listMultipartUploadPartsResponseIterator(ListMultipartUploadPartsRequest request) Creates a new iterable which will iterate over the responses received from the listMultipartUploadParts operation.
Iterable<MultipartUpload>	listMultipartUploadsRecordIterator(ListMultipartUploadsRequest request) Creates a new iterable which will iterate over the MultipartUpload objects contained in responses from the listMultipartUploads operation.
Iterable<ListMultipartUploadsResponse>	listMultipartUploadsResponseIterator(ListMultipartUploadsRequest request) Creates a new iterable which will iterate over the responses received from the listMultipartUploads operation.
Iterable<ObjectSummary>	listObjectsRecordIterator(ListObjectsRequest request) Creates a new iterable which will iterate over the ObjectSummary objects contained in responses from the listObjects operation.
Iterable<ListObjectsResponse>	listObjectsResponseIterator(ListObjectsRequest request) Creates a new iterable which will iterate over the responses received from the listObjects operation.
Iterable<ObjectVersionSummary>	listObjectVersionsRecordIterator(ListObjectVersionsRequest request) Creates a new iterable which will iterate over the ObjectVersionSummary objects contained in responses from the listObjectVersions operation.
Iterable<ListObjectVersionsResponse>	listObjectVersionsResponseIterator(ListObjectVersionsRequest request) Creates a new iterable which will iterate over the responses received from the listObjectVersions operation.
Iterable<PreauthenticatedRequestSummary>	listPreauthenticatedRequestsRecordIterator(ListPreauthenticatedRequestsRequest request) Creates a new iterable which will iterate over the PreauthenticatedRequestSummary objects contained in responses from the listPreauthenticatedRequests operation.
Iterable<ListPreauthenticatedRequestsResponse>	listPreauthenticatedRequestsResponseIterator(ListPreauthenticatedRequestsRequest request) Creates a new iterable which will iterate over the responses received from the listPreauthenticatedRequests operation.
Iterable<ReplicationPolicySummary>	listReplicationPoliciesRecordIterator(ListReplicationPoliciesRequest request) Creates a new iterable which will iterate over the ReplicationPolicySummary objects contained in responses from the listReplicationPolicies operation.
Iterable<ListReplicationPoliciesResponse>	listReplicationPoliciesResponseIterator(ListReplicationPoliciesRequest request) Creates a new iterable which will iterate over the responses received from the listReplicationPolicies operation.
Iterable<ReplicationSource>	listReplicationSourcesRecordIterator(ListReplicationSourcesRequest request) Creates a new iterable which will iterate over the ReplicationSource objects contained in responses from the listReplicationSources operation.
Iterable<ListReplicationSourcesResponse>	listReplicationSourcesResponseIterator(ListReplicationSourcesRequest request) Creates a new iterable which will iterate over the responses received from the listReplicationSources operation.
Iterable<RetentionRuleSummary>	listRetentionRulesRecordIterator(ListRetentionRulesRequest request) Creates a new iterable which will iterate over the RetentionRuleSummary objects contained in responses from the listRetentionRules operation.
Iterable<ListRetentionRulesResponse>	listRetentionRulesResponseIterator(ListRetentionRulesRequest request) Creates a new iterable which will iterate over the responses received from the listRetentionRules operation.
Iterable<WorkRequestError>	listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request) Creates a new iterable which will iterate over the WorkRequestError objects contained in responses from the listWorkRequestErrors operation.
Iterable<ListWorkRequestErrorsResponse>	listWorkRequestErrorsResponseIterator(ListWorkRequestErrorsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequestErrors operation.
Iterable<WorkRequestLogEntry>	listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request) Creates a new iterable which will iterate over the WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation.
Iterable<ListWorkRequestLogsResponse>	listWorkRequestLogsResponseIterator(ListWorkRequestLogsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequestLogs operation.
Iterable<WorkRequestSummary>	listWorkRequestsRecordIterator(ListWorkRequestsRequest request) Creates a new iterable which will iterate over the WorkRequestSummary objects contained in responses from the listWorkRequests operation.
Iterable<ListWorkRequestsResponse>	listWorkRequestsResponseIterator(ListWorkRequestsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkRequests operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStoragePaginators

@ConstructorProperties(value="client")
public ObjectStoragePaginators(ObjectStorage client)

Method Detail

listBucketsResponseIterator

public Iterable<ListBucketsResponse> listBucketsResponseIterator(ListBucketsRequest request)

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

listBucketsRecordIterator

public Iterable<BucketSummary> listBucketsRecordIterator(ListBucketsRequest request)

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

listMultipartUploadPartsResponseIterator

public Iterable<ListMultipartUploadPartsResponse> listMultipartUploadPartsResponseIterator(ListMultipartUploadPartsRequest request)

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

listMultipartUploadPartsRecordIterator

public Iterable<MultipartUploadPartSummary> listMultipartUploadPartsRecordIterator(ListMultipartUploadPartsRequest request)

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

listMultipartUploadsResponseIterator

public Iterable<ListMultipartUploadsResponse> listMultipartUploadsResponseIterator(ListMultipartUploadsRequest request)

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

listMultipartUploadsRecordIterator

public Iterable<MultipartUpload> listMultipartUploadsRecordIterator(ListMultipartUploadsRequest request)

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

listObjectVersionsResponseIterator

public Iterable<ListObjectVersionsResponse> listObjectVersionsResponseIterator(ListObjectVersionsRequest request)

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

listObjectVersionsRecordIterator

public Iterable<ObjectVersionSummary> listObjectVersionsRecordIterator(ListObjectVersionsRequest request)

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

listObjectsResponseIterator

public Iterable<ListObjectsResponse> listObjectsResponseIterator(ListObjectsRequest request)

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

listObjectsRecordIterator

public Iterable<ObjectSummary> listObjectsRecordIterator(ListObjectsRequest request)

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

listPreauthenticatedRequestsResponseIterator

public Iterable<ListPreauthenticatedRequestsResponse> listPreauthenticatedRequestsResponseIterator(ListPreauthenticatedRequestsRequest request)

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

listPreauthenticatedRequestsRecordIterator

public Iterable<PreauthenticatedRequestSummary> listPreauthenticatedRequestsRecordIterator(ListPreauthenticatedRequestsRequest request)

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

listReplicationPoliciesResponseIterator

public Iterable<ListReplicationPoliciesResponse> listReplicationPoliciesResponseIterator(ListReplicationPoliciesRequest request)

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

listReplicationPoliciesRecordIterator

public Iterable<ReplicationPolicySummary> listReplicationPoliciesRecordIterator(ListReplicationPoliciesRequest request)

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

listReplicationSourcesResponseIterator

public Iterable<ListReplicationSourcesResponse> listReplicationSourcesResponseIterator(ListReplicationSourcesRequest request)

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

listReplicationSourcesRecordIterator

public Iterable<ReplicationSource> listReplicationSourcesRecordIterator(ListReplicationSourcesRequest request)

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

listRetentionRulesResponseIterator

public Iterable<ListRetentionRulesResponse> listRetentionRulesResponseIterator(ListRetentionRulesRequest request)

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

listRetentionRulesRecordIterator

public Iterable<RetentionRuleSummary> listRetentionRulesRecordIterator(ListRetentionRulesRequest request)

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

listWorkRequestErrorsResponseIterator

public Iterable<ListWorkRequestErrorsResponse> listWorkRequestErrorsResponseIterator(ListWorkRequestErrorsRequest request)

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

listWorkRequestErrorsRecordIterator

public Iterable<WorkRequestError> listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request)

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

listWorkRequestLogsResponseIterator

public Iterable<ListWorkRequestLogsResponse> listWorkRequestLogsResponseIterator(ListWorkRequestLogsRequest request)

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

listWorkRequestLogsRecordIterator

public Iterable<WorkRequestLogEntry> listWorkRequestLogsRecordIterator(ListWorkRequestLogsRequest request)

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

listWorkRequestsResponseIterator

public Iterable<ListWorkRequestsResponse> listWorkRequestsResponseIterator(ListWorkRequestsRequest request)

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

listWorkRequestsRecordIterator

public Iterable<WorkRequestSummary> listWorkRequestsRecordIterator(ListWorkRequestsRequest request)

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