Package com.oracle.bmc.multicloud

Class MetadataPaginators

java.lang.Object

com.oracle.bmc.multicloud.MetadataPaginators

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

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

Method Summary

Modifier and Type	Method	Description
Iterable<ExternalLocationsMetadatumSummary>	listExternalLocationDetailsMetadataRecordIterator(ListExternalLocationDetailsMetadataRequest request)	Creates a new iterable which will iterate over the ExternalLocationsMetadatumSummary objects contained in responses from the listExternalLocationDetailsMetadata operation.
Iterable<ListExternalLocationDetailsMetadataResponse>	listExternalLocationDetailsMetadataResponseIterator(ListExternalLocationDetailsMetadataRequest request)	Creates a new iterable which will iterate over the responses received from the listExternalLocationDetailsMetadata operation.
Iterable<ExternalLocationMappingMetadatumSummary>	listExternalLocationMappingMetadataRecordIterator(ListExternalLocationMappingMetadataRequest request)	Creates a new iterable which will iterate over the ExternalLocationMappingMetadatumSummary objects contained in responses from the listExternalLocationMappingMetadata operation.
Iterable<ListExternalLocationMappingMetadataResponse>	listExternalLocationMappingMetadataResponseIterator(ListExternalLocationMappingMetadataRequest request)	Creates a new iterable which will iterate over the responses received from the listExternalLocationMappingMetadata operation.
Iterable<ExternalLocationSummariesMetadatumSummary>	listExternalLocationSummariesMetadataRecordIterator(ListExternalLocationSummariesMetadataRequest request)	Creates a new iterable which will iterate over the ExternalLocationSummariesMetadatumSummary objects contained in responses from the listExternalLocationSummariesMetadata operation.
Iterable<ListExternalLocationSummariesMetadataResponse>	listExternalLocationSummariesMetadataResponseIterator(ListExternalLocationSummariesMetadataRequest request)	Creates a new iterable which will iterate over the responses received from the listExternalLocationSummariesMetadata operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataPaginators

public MetadataPaginators(Metadata client)

Method Detail

listExternalLocationDetailsMetadataResponseIterator

public Iterable<ListExternalLocationDetailsMetadataResponse> listExternalLocationDetailsMetadataResponseIterator(ListExternalLocationDetailsMetadataRequest request)

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

listExternalLocationDetailsMetadataRecordIterator

public Iterable<ExternalLocationsMetadatumSummary> listExternalLocationDetailsMetadataRecordIterator(ListExternalLocationDetailsMetadataRequest request)

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

listExternalLocationMappingMetadataResponseIterator

public Iterable<ListExternalLocationMappingMetadataResponse> listExternalLocationMappingMetadataResponseIterator(ListExternalLocationMappingMetadataRequest request)

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

listExternalLocationMappingMetadataRecordIterator

public Iterable<ExternalLocationMappingMetadatumSummary> listExternalLocationMappingMetadataRecordIterator(ListExternalLocationMappingMetadataRequest request)

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

listExternalLocationSummariesMetadataResponseIterator

public Iterable<ListExternalLocationSummariesMetadataResponse> listExternalLocationSummariesMetadataResponseIterator(ListExternalLocationSummariesMetadataRequest request)

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

listExternalLocationSummariesMetadataRecordIterator

public Iterable<ExternalLocationSummariesMetadatumSummary> listExternalLocationSummariesMetadataRecordIterator(ListExternalLocationSummariesMetadataRequest request)

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