Package com.oracle.bmc.healthchecks

Class HealthChecksPaginators

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

      • HealthChecksPaginators

        public HealthChecksPaginators​(HealthChecks client)

    • Method Detail

      • listHealthChecksVantagePointsResponseIterator

        public Iterable<ListHealthChecksVantagePointsResponse> listHealthChecksVantagePointsResponseIterator​(ListHealthChecksVantagePointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHealthChecksVantagePoints 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.

      • listHttpMonitorsResponseIterator

        public Iterable<ListHttpMonitorsResponse> listHttpMonitorsResponseIterator​(ListHttpMonitorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHttpMonitors 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.

      • listHttpMonitorsRecordIterator

        public Iterable<HttpMonitorSummary> listHttpMonitorsRecordIterator​(ListHttpMonitorsRequest request)
        Creates a new iterable which will iterate over the HttpMonitorSummary objects contained in responses from the listHttpMonitors 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 HttpMonitorSummary objects contained in responses received from the service.

      • listHttpProbeResultsResponseIterator

        public Iterable<ListHttpProbeResultsResponse> listHttpProbeResultsResponseIterator​(ListHttpProbeResultsRequest request)
        Creates a new iterable which will iterate over the responses received from the listHttpProbeResults 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.

      • listHttpProbeResultsRecordIterator

        public Iterable<HttpProbeResultSummary> listHttpProbeResultsRecordIterator​(ListHttpProbeResultsRequest request)
        Creates a new iterable which will iterate over the HttpProbeResultSummary objects contained in responses from the listHttpProbeResults 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 HttpProbeResultSummary objects contained in responses received from the service.

      • listPingMonitorsResponseIterator

        public Iterable<ListPingMonitorsResponse> listPingMonitorsResponseIterator​(ListPingMonitorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listPingMonitors 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.

      • listPingMonitorsRecordIterator

        public Iterable<PingMonitorSummary> listPingMonitorsRecordIterator​(ListPingMonitorsRequest request)
        Creates a new iterable which will iterate over the PingMonitorSummary objects contained in responses from the listPingMonitors 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 PingMonitorSummary objects contained in responses received from the service.

      • listPingProbeResultsResponseIterator

        public Iterable<ListPingProbeResultsResponse> listPingProbeResultsResponseIterator​(ListPingProbeResultsRequest request)
        Creates a new iterable which will iterate over the responses received from the listPingProbeResults 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.

      • listPingProbeResultsRecordIterator

        public Iterable<PingProbeResultSummary> listPingProbeResultsRecordIterator​(ListPingProbeResultsRequest request)
        Creates a new iterable which will iterate over the PingProbeResultSummary objects contained in responses from the listPingProbeResults 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 PingProbeResultSummary objects contained in responses received from the service.