Package com.oracle.bmc.cloudbridge

Class OcbAgentSvcPaginators

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

      • OcbAgentSvcPaginators

        public OcbAgentSvcPaginators​(OcbAgentSvc client)

    • Method Detail

      • listAgentDependenciesResponseIterator

        public Iterable<ListAgentDependenciesResponse> listAgentDependenciesResponseIterator​(ListAgentDependenciesRequest request)
        Creates a new iterable which will iterate over the responses received from the listAgentDependencies 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.

      • listAgentDependenciesRecordIterator

        public Iterable<AgentDependencySummary> listAgentDependenciesRecordIterator​(ListAgentDependenciesRequest request)
        Creates a new iterable which will iterate over the AgentDependencySummary objects contained in responses from the listAgentDependencies 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 AgentDependencySummary objects contained in responses received from the service.

      • listAgentsResponseIterator

        public Iterable<ListAgentsResponse> listAgentsResponseIterator​(ListAgentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listAgents 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.

      • listAgentsRecordIterator

        public Iterable<AgentSummary> listAgentsRecordIterator​(ListAgentsRequest request)
        Creates a new iterable which will iterate over the AgentSummary objects contained in responses from the listAgents 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 AgentSummary objects contained in responses received from the service.

      • listApplianceImagesResponseIterator

        public Iterable<ListApplianceImagesResponse> listApplianceImagesResponseIterator​(ListApplianceImagesRequest request)
        Creates a new iterable which will iterate over the responses received from the listApplianceImages 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.

      • listApplianceImagesRecordIterator

        public Iterable<ApplianceImageSummary> listApplianceImagesRecordIterator​(ListApplianceImagesRequest request)
        Creates a new iterable which will iterate over the ApplianceImageSummary objects contained in responses from the listApplianceImages 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 ApplianceImageSummary objects contained in responses received from the service.

      • listEnvironmentsResponseIterator

        public Iterable<ListEnvironmentsResponse> listEnvironmentsResponseIterator​(ListEnvironmentsRequest request)
        Creates a new iterable which will iterate over the responses received from the listEnvironments 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.

      • listEnvironmentsRecordIterator

        public Iterable<EnvironmentSummary> listEnvironmentsRecordIterator​(ListEnvironmentsRequest request)
        Creates a new iterable which will iterate over the EnvironmentSummary objects contained in responses from the listEnvironments 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 EnvironmentSummary objects contained in responses received from the service.