Class ManagementAgentPaginators
- java.lang.Object
-
- com.oracle.bmc.managementagent.ManagementAgentPaginators
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20200202") public class ManagementAgentPaginators extends Object
Collection of helper methods that can be used to provide anIterable
interface to any list operations of ManagementAgent 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 theIterable
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 ManagementAgentPaginators(ManagementAgent client)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterable<AvailabilityHistorySummary>
listAvailabilityHistoriesRecordIterator(ListAvailabilityHistoriesRequest request)
Creates a new iterable which will iterate over theAvailabilityHistorySummary
objects contained in responses from the listAvailabilityHistories operation.Iterable<ListAvailabilityHistoriesResponse>
listAvailabilityHistoriesResponseIterator(ListAvailabilityHistoriesRequest request)
Creates a new iterable which will iterate over the responses received from the listAvailabilityHistories operation.Iterable<DataSourceSummary>
listDataSourcesRecordIterator(ListDataSourcesRequest request)
Creates a new iterable which will iterate over theDataSourceSummary
objects contained in responses from the listDataSources operation.Iterable<ListDataSourcesResponse>
listDataSourcesResponseIterator(ListDataSourcesRequest request)
Creates a new iterable which will iterate over the responses received from the listDataSources operation.Iterable<ManagementAgentImageSummary>
listManagementAgentImagesRecordIterator(ListManagementAgentImagesRequest request)
Creates a new iterable which will iterate over theManagementAgentImageSummary
objects contained in responses from the listManagementAgentImages operation.Iterable<ListManagementAgentImagesResponse>
listManagementAgentImagesResponseIterator(ListManagementAgentImagesRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentImages operation.Iterable<ManagementAgentInstallKeySummary>
listManagementAgentInstallKeysRecordIterator(ListManagementAgentInstallKeysRequest request)
Creates a new iterable which will iterate over theManagementAgentInstallKeySummary
objects contained in responses from the listManagementAgentInstallKeys operation.Iterable<ListManagementAgentInstallKeysResponse>
listManagementAgentInstallKeysResponseIterator(ListManagementAgentInstallKeysRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentInstallKeys operation.Iterable<ManagementAgentPluginSummary>
listManagementAgentPluginsRecordIterator(ListManagementAgentPluginsRequest request)
Creates a new iterable which will iterate over theManagementAgentPluginSummary
objects contained in responses from the listManagementAgentPlugins operation.Iterable<ListManagementAgentPluginsResponse>
listManagementAgentPluginsResponseIterator(ListManagementAgentPluginsRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentPlugins operation.Iterable<ManagementAgentSummary>
listManagementAgentsRecordIterator(ListManagementAgentsRequest request)
Creates a new iterable which will iterate over theManagementAgentSummary
objects contained in responses from the listManagementAgents operation.Iterable<ListManagementAgentsResponse>
listManagementAgentsResponseIterator(ListManagementAgentsRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgents operation.Iterable<WorkRequestError>
listWorkRequestErrorsRecordIterator(ListWorkRequestErrorsRequest request)
Creates a new iterable which will iterate over theWorkRequestError
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 theWorkRequestLogEntry
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 theWorkRequestSummary
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.
-
-
-
Constructor Detail
-
ManagementAgentPaginators
public ManagementAgentPaginators(ManagementAgent client)
-
-
Method Detail
-
listAvailabilityHistoriesResponseIterator
public Iterable<ListAvailabilityHistoriesResponse> listAvailabilityHistoriesResponseIterator(ListAvailabilityHistoriesRequest request)
Creates a new iterable which will iterate over the responses received from the listAvailabilityHistories 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.
-
listAvailabilityHistoriesRecordIterator
public Iterable<AvailabilityHistorySummary> listAvailabilityHistoriesRecordIterator(ListAvailabilityHistoriesRequest request)
Creates a new iterable which will iterate over theAvailabilityHistorySummary
objects contained in responses from the listAvailabilityHistories 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 theAvailabilityHistorySummary
objects contained in responses received from the service.
-
listDataSourcesResponseIterator
public Iterable<ListDataSourcesResponse> listDataSourcesResponseIterator(ListDataSourcesRequest request)
Creates a new iterable which will iterate over the responses received from the listDataSources 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.
-
listDataSourcesRecordIterator
public Iterable<DataSourceSummary> listDataSourcesRecordIterator(ListDataSourcesRequest request)
Creates a new iterable which will iterate over theDataSourceSummary
objects contained in responses from the listDataSources 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 theDataSourceSummary
objects contained in responses received from the service.
-
listManagementAgentImagesResponseIterator
public Iterable<ListManagementAgentImagesResponse> listManagementAgentImagesResponseIterator(ListManagementAgentImagesRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentImages 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.
-
listManagementAgentImagesRecordIterator
public Iterable<ManagementAgentImageSummary> listManagementAgentImagesRecordIterator(ListManagementAgentImagesRequest request)
Creates a new iterable which will iterate over theManagementAgentImageSummary
objects contained in responses from the listManagementAgentImages 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 theManagementAgentImageSummary
objects contained in responses received from the service.
-
listManagementAgentInstallKeysResponseIterator
public Iterable<ListManagementAgentInstallKeysResponse> listManagementAgentInstallKeysResponseIterator(ListManagementAgentInstallKeysRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentInstallKeys 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.
-
listManagementAgentInstallKeysRecordIterator
public Iterable<ManagementAgentInstallKeySummary> listManagementAgentInstallKeysRecordIterator(ListManagementAgentInstallKeysRequest request)
Creates a new iterable which will iterate over theManagementAgentInstallKeySummary
objects contained in responses from the listManagementAgentInstallKeys 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 theManagementAgentInstallKeySummary
objects contained in responses received from the service.
-
listManagementAgentPluginsResponseIterator
public Iterable<ListManagementAgentPluginsResponse> listManagementAgentPluginsResponseIterator(ListManagementAgentPluginsRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgentPlugins 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.
-
listManagementAgentPluginsRecordIterator
public Iterable<ManagementAgentPluginSummary> listManagementAgentPluginsRecordIterator(ListManagementAgentPluginsRequest request)
Creates a new iterable which will iterate over theManagementAgentPluginSummary
objects contained in responses from the listManagementAgentPlugins 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 theManagementAgentPluginSummary
objects contained in responses received from the service.
-
listManagementAgentsResponseIterator
public Iterable<ListManagementAgentsResponse> listManagementAgentsResponseIterator(ListManagementAgentsRequest request)
Creates a new iterable which will iterate over the responses received from the listManagementAgents 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.
-
listManagementAgentsRecordIterator
public Iterable<ManagementAgentSummary> listManagementAgentsRecordIterator(ListManagementAgentsRequest request)
Creates a new iterable which will iterate over theManagementAgentSummary
objects contained in responses from the listManagementAgents 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 theManagementAgentSummary
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 theWorkRequestError
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 theWorkRequestError
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 theWorkRequestLogEntry
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 theWorkRequestLogEntry
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 theWorkRequestSummary
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 theWorkRequestSummary
objects contained in responses received from the service.
-
-