Package com.oracle.bmc.apmsynthetics

Class ApmSyntheticPaginators

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

      • ApmSyntheticPaginators

        public ApmSyntheticPaginators​(ApmSynthetic client)

    • Method Detail

      • listDedicatedVantagePointsResponseIterator

        public Iterable<ListDedicatedVantagePointsResponse> listDedicatedVantagePointsResponseIterator​(ListDedicatedVantagePointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listDedicatedVantagePoints 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.

      • listMonitorsResponseIterator

        public Iterable<ListMonitorsResponse> listMonitorsResponseIterator​(ListMonitorsRequest request)
        Creates a new iterable which will iterate over the responses received from the listMonitors 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.

      • listMonitorsRecordIterator

        public Iterable<MonitorSummary> listMonitorsRecordIterator​(ListMonitorsRequest request)
        Creates a new iterable which will iterate over the MonitorSummary objects contained in responses from the listMonitors 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 MonitorSummary objects contained in responses received from the service.

      • listOnPremiseVantagePointsResponseIterator

        public Iterable<ListOnPremiseVantagePointsResponse> listOnPremiseVantagePointsResponseIterator​(ListOnPremiseVantagePointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listOnPremiseVantagePoints 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.

      • listPublicVantagePointsResponseIterator

        public Iterable<ListPublicVantagePointsResponse> listPublicVantagePointsResponseIterator​(ListPublicVantagePointsRequest request)
        Creates a new iterable which will iterate over the responses received from the listPublicVantagePoints 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.

      • listScriptsResponseIterator

        public Iterable<ListScriptsResponse> listScriptsResponseIterator​(ListScriptsRequest request)
        Creates a new iterable which will iterate over the responses received from the listScripts 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.

      • listScriptsRecordIterator

        public Iterable<ScriptSummary> listScriptsRecordIterator​(ListScriptsRequest request)
        Creates a new iterable which will iterate over the ScriptSummary objects contained in responses from the listScripts 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 ScriptSummary objects contained in responses received from the service.

      • listWorkersResponseIterator

        public Iterable<ListWorkersResponse> listWorkersResponseIterator​(ListWorkersRequest request)
        Creates a new iterable which will iterate over the responses received from the listWorkers 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.

      • listWorkersRecordIterator

        public Iterable<WorkerSummary> listWorkersRecordIterator​(ListWorkersRequest request)
        Creates a new iterable which will iterate over the WorkerSummary objects contained in responses from the listWorkers 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 WorkerSummary objects contained in responses received from the service.