com.oracle.bmc.resourcemanager

Class ResourceManagerPaginators

java.lang.Object

com.oracle.bmc.resourcemanager.ResourceManagerPaginators

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

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

Method Summary

Modifier and Type	Method and Description
Iterable<LogEntry>	getJobLogsRecordIterator(GetJobLogsRequest request) Creates a new iterable which will iterate over the LogEntry objects contained in responses from the getJobLogs operation.
Iterable<GetJobLogsResponse>	getJobLogsResponseIterator(GetJobLogsRequest request) Creates a new iterable which will iterate over the responses received from the getJobLogs operation.
Iterable<ConfigurationSourceProviderSummary>	listConfigurationSourceProvidersRecordIterator(ListConfigurationSourceProvidersRequest request) Creates a new iterable which will iterate over the ConfigurationSourceProviderSummary objects contained in responses from the listConfigurationSourceProviders operation.
Iterable<ListConfigurationSourceProvidersResponse>	listConfigurationSourceProvidersResponseIterator(ListConfigurationSourceProvidersRequest request) Creates a new iterable which will iterate over the responses received from the listConfigurationSourceProviders operation.
Iterable<JobSummary>	listJobsRecordIterator(ListJobsRequest request) Creates a new iterable which will iterate over the JobSummary objects contained in responses from the listJobs operation.
Iterable<ListJobsResponse>	listJobsResponseIterator(ListJobsRequest request) Creates a new iterable which will iterate over the responses received from the listJobs operation.
Iterable<PrivateEndpointSummary>	listPrivateEndpointsRecordIterator(ListPrivateEndpointsRequest request) Creates a new iterable which will iterate over the PrivateEndpointSummary objects contained in responses from the listPrivateEndpoints operation.
Iterable<ListPrivateEndpointsResponse>	listPrivateEndpointsResponseIterator(ListPrivateEndpointsRequest request) Creates a new iterable which will iterate over the responses received from the listPrivateEndpoints operation.
Iterable<StackResourceDriftSummary>	listStackResourceDriftDetailsRecordIterator(ListStackResourceDriftDetailsRequest request) Creates a new iterable which will iterate over the StackResourceDriftSummary objects contained in responses from the listStackResourceDriftDetails operation.
Iterable<ListStackResourceDriftDetailsResponse>	listStackResourceDriftDetailsResponseIterator(ListStackResourceDriftDetailsRequest request) Creates a new iterable which will iterate over the responses received from the listStackResourceDriftDetails operation.
Iterable<StackSummary>	listStacksRecordIterator(ListStacksRequest request) Creates a new iterable which will iterate over the StackSummary objects contained in responses from the listStacks operation.
Iterable<ListStacksResponse>	listStacksResponseIterator(ListStacksRequest request) Creates a new iterable which will iterate over the responses received from the listStacks operation.
Iterable<TemplateSummary>	listTemplatesRecordIterator(ListTemplatesRequest request) Creates a new iterable which will iterate over the TemplateSummary objects contained in responses from the listTemplates operation.
Iterable<ListTemplatesResponse>	listTemplatesResponseIterator(ListTemplatesRequest request) Creates a new iterable which will iterate over the responses received from the listTemplates 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

ResourceManagerPaginators

public ResourceManagerPaginators(ResourceManager client)

Method Detail

getJobLogsResponseIterator

public Iterable<GetJobLogsResponse> getJobLogsResponseIterator(GetJobLogsRequest request)

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

getJobLogsRecordIterator

public Iterable<LogEntry> getJobLogsRecordIterator(GetJobLogsRequest request)

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

listConfigurationSourceProvidersResponseIterator

public Iterable<ListConfigurationSourceProvidersResponse> listConfigurationSourceProvidersResponseIterator(ListConfigurationSourceProvidersRequest request)

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

listConfigurationSourceProvidersRecordIterator

public Iterable<ConfigurationSourceProviderSummary> listConfigurationSourceProvidersRecordIterator(ListConfigurationSourceProvidersRequest request)

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

listJobsResponseIterator

public Iterable<ListJobsResponse> listJobsResponseIterator(ListJobsRequest request)

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

listJobsRecordIterator

public Iterable<JobSummary> listJobsRecordIterator(ListJobsRequest request)

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

listPrivateEndpointsResponseIterator

public Iterable<ListPrivateEndpointsResponse> listPrivateEndpointsResponseIterator(ListPrivateEndpointsRequest request)

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

listPrivateEndpointsRecordIterator

public Iterable<PrivateEndpointSummary> listPrivateEndpointsRecordIterator(ListPrivateEndpointsRequest request)

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

listStackResourceDriftDetailsResponseIterator

public Iterable<ListStackResourceDriftDetailsResponse> listStackResourceDriftDetailsResponseIterator(ListStackResourceDriftDetailsRequest request)

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

listStackResourceDriftDetailsRecordIterator

public Iterable<StackResourceDriftSummary> listStackResourceDriftDetailsRecordIterator(ListStackResourceDriftDetailsRequest request)

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

listStacksResponseIterator

public Iterable<ListStacksResponse> listStacksResponseIterator(ListStacksRequest request)

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

listStacksRecordIterator

public Iterable<StackSummary> listStacksRecordIterator(ListStacksRequest request)

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

listTemplatesResponseIterator

public Iterable<ListTemplatesResponse> listTemplatesResponseIterator(ListTemplatesRequest request)

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

listTemplatesRecordIterator

public Iterable<TemplateSummary> listTemplatesRecordIterator(ListTemplatesRequest request)

Creates a new iterable which will iterate over the TemplateSummary objects contained in responses from the listTemplates 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 TemplateSummary 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.