Package com.oracle.bmc.monitoring

Class MonitoringPaginators

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public class MonitoringPaginators
extends Object
    Collection of helper methods that can be used to provide an Iterable interface to any list operations of Monitoring 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 Detail

      • MonitoringPaginators

        public MonitoringPaginators​(Monitoring client)

    • Method Detail

      • listAlarmSuppressionsResponseIterator

        public Iterable<ListAlarmSuppressionsResponse> listAlarmSuppressionsResponseIterator​(ListAlarmSuppressionsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAlarmSuppressions 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.

      • listAlarmSuppressionsRecordIterator

        public Iterable<AlarmSuppressionSummary> listAlarmSuppressionsRecordIterator​(ListAlarmSuppressionsRequest request)
        Creates a new iterable which will iterate over the AlarmSuppressionSummary objects contained in responses from the listAlarmSuppressions 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 AlarmSuppressionSummary objects contained in responses received from the service.

      • listAlarmsResponseIterator

        public Iterable<ListAlarmsResponse> listAlarmsResponseIterator​(ListAlarmsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAlarms 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.

      • listAlarmsRecordIterator

        public Iterable<AlarmSummary> listAlarmsRecordIterator​(ListAlarmsRequest request)
        Creates a new iterable which will iterate over the AlarmSummary objects contained in responses from the listAlarms 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 AlarmSummary objects contained in responses received from the service.

      • listAlarmsStatusResponseIterator

        public Iterable<ListAlarmsStatusResponse> listAlarmsStatusResponseIterator​(ListAlarmsStatusRequest request)
        Creates a new iterable which will iterate over the responses received from the listAlarmsStatus 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.

      • listAlarmsStatusRecordIterator

        public Iterable<AlarmStatusSummary> listAlarmsStatusRecordIterator​(ListAlarmsStatusRequest request)
        Creates a new iterable which will iterate over the AlarmStatusSummary objects contained in responses from the listAlarmsStatus 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 AlarmStatusSummary objects contained in responses received from the service.

      • listMetricsResponseIterator

        public Iterable<ListMetricsResponse> listMetricsResponseIterator​(ListMetricsRequest request)
        Creates a new iterable which will iterate over the responses received from the listMetrics 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.

      • listMetricsRecordIterator

        public Iterable<Metric> listMetricsRecordIterator​(ListMetricsRequest request)
        Creates a new iterable which will iterate over the Metric objects contained in responses from the listMetrics 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 Metric objects contained in responses received from the service.