com.oracle.bmc.containerengine

Class ContainerEnginePaginators

java.lang.Object

com.oracle.bmc.containerengine.ContainerEnginePaginators

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180222")
public class ContainerEnginePaginators
extends Object

Collection of helper methods that can be used to provide an Iterable interface to any list operations of ContainerEngine 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 Summary

Constructors

Constructor and Description
ContainerEnginePaginators(ContainerEngine client)

Method Summary

Modifier and Type	Method and Description
Iterable<AddonOptionSummary>	listAddonOptionsRecordIterator(ListAddonOptionsRequest request) Creates a new iterable which will iterate over the AddonOptionSummary objects contained in responses from the listAddonOptions operation.
Iterable<ListAddonOptionsResponse>	listAddonOptionsResponseIterator(ListAddonOptionsRequest request) Creates a new iterable which will iterate over the responses received from the listAddonOptions operation.
Iterable<AddonSummary>	listAddonsRecordIterator(ListAddonsRequest request) Creates a new iterable which will iterate over the AddonSummary objects contained in responses from the listAddons operation.
Iterable<ListAddonsResponse>	listAddonsResponseIterator(ListAddonsRequest request) Creates a new iterable which will iterate over the responses received from the listAddons operation.
Iterable<ClusterSummary>	listClustersRecordIterator(ListClustersRequest request) Creates a new iterable which will iterate over the ClusterSummary objects contained in responses from the listClusters operation.
Iterable<ListClustersResponse>	listClustersResponseIterator(ListClustersRequest request) Creates a new iterable which will iterate over the responses received from the listClusters operation.
Iterable<NodePoolSummary>	listNodePoolsRecordIterator(ListNodePoolsRequest request) Creates a new iterable which will iterate over the NodePoolSummary objects contained in responses from the listNodePools operation.
Iterable<ListNodePoolsResponse>	listNodePoolsResponseIterator(ListNodePoolsRequest request) Creates a new iterable which will iterate over the responses received from the listNodePools operation.
Iterable<PodShapeSummary>	listPodShapesRecordIterator(ListPodShapesRequest request) Creates a new iterable which will iterate over the PodShapeSummary objects contained in responses from the listPodShapes operation.
Iterable<ListPodShapesResponse>	listPodShapesResponseIterator(ListPodShapesRequest request) Creates a new iterable which will iterate over the responses received from the listPodShapes operation.
Iterable<VirtualNodePoolSummary>	listVirtualNodePoolsRecordIterator(ListVirtualNodePoolsRequest request) Creates a new iterable which will iterate over the VirtualNodePoolSummary objects contained in responses from the listVirtualNodePools operation.
Iterable<ListVirtualNodePoolsResponse>	listVirtualNodePoolsResponseIterator(ListVirtualNodePoolsRequest request) Creates a new iterable which will iterate over the responses received from the listVirtualNodePools operation.
Iterable<VirtualNodeSummary>	listVirtualNodesRecordIterator(ListVirtualNodesRequest request) Creates a new iterable which will iterate over the VirtualNodeSummary objects contained in responses from the listVirtualNodes operation.
Iterable<ListVirtualNodesResponse>	listVirtualNodesResponseIterator(ListVirtualNodesRequest request) Creates a new iterable which will iterate over the responses received from the listVirtualNodes operation.
Iterable<WorkloadMappingSummary>	listWorkloadMappingsRecordIterator(ListWorkloadMappingsRequest request) Creates a new iterable which will iterate over the WorkloadMappingSummary objects contained in responses from the listWorkloadMappings operation.
Iterable<ListWorkloadMappingsResponse>	listWorkloadMappingsResponseIterator(ListWorkloadMappingsRequest request) Creates a new iterable which will iterate over the responses received from the listWorkloadMappings operation.
Iterable<WorkRequestSummary>	listWorkRequestsRecordIterator(ListWorkRequestsRequest request) Creates a new iterable which will iterate over the WorkRequestSummary 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContainerEnginePaginators

public ContainerEnginePaginators(ContainerEngine client)

Method Detail

listAddonOptionsResponseIterator

public Iterable<ListAddonOptionsResponse> listAddonOptionsResponseIterator(ListAddonOptionsRequest request)

Creates a new iterable which will iterate over the responses received from the listAddonOptions 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.

listAddonOptionsRecordIterator

public Iterable<AddonOptionSummary> listAddonOptionsRecordIterator(ListAddonOptionsRequest request)

Creates a new iterable which will iterate over the AddonOptionSummary objects contained in responses from the listAddonOptions 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 AddonOptionSummary objects contained in responses received from the service.

listAddonsResponseIterator

public Iterable<ListAddonsResponse> listAddonsResponseIterator(ListAddonsRequest request)

Creates a new iterable which will iterate over the responses received from the listAddons 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.

listAddonsRecordIterator

public Iterable<AddonSummary> listAddonsRecordIterator(ListAddonsRequest request)

Creates a new iterable which will iterate over the AddonSummary objects contained in responses from the listAddons 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 AddonSummary objects contained in responses received from the service.

listClustersResponseIterator

public Iterable<ListClustersResponse> listClustersResponseIterator(ListClustersRequest request)

Creates a new iterable which will iterate over the responses received from the listClusters 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.

listClustersRecordIterator

public Iterable<ClusterSummary> listClustersRecordIterator(ListClustersRequest request)

Creates a new iterable which will iterate over the ClusterSummary objects contained in responses from the listClusters 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 ClusterSummary objects contained in responses received from the service.

listNodePoolsResponseIterator

public Iterable<ListNodePoolsResponse> listNodePoolsResponseIterator(ListNodePoolsRequest request)

Creates a new iterable which will iterate over the responses received from the listNodePools 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.

listNodePoolsRecordIterator

public Iterable<NodePoolSummary> listNodePoolsRecordIterator(ListNodePoolsRequest request)

Creates a new iterable which will iterate over the NodePoolSummary objects contained in responses from the listNodePools 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 NodePoolSummary objects contained in responses received from the service.

listPodShapesResponseIterator

public Iterable<ListPodShapesResponse> listPodShapesResponseIterator(ListPodShapesRequest request)

Creates a new iterable which will iterate over the responses received from the listPodShapes 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.

listPodShapesRecordIterator

public Iterable<PodShapeSummary> listPodShapesRecordIterator(ListPodShapesRequest request)

Creates a new iterable which will iterate over the PodShapeSummary objects contained in responses from the listPodShapes 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 PodShapeSummary objects contained in responses received from the service.

listVirtualNodePoolsResponseIterator

public Iterable<ListVirtualNodePoolsResponse> listVirtualNodePoolsResponseIterator(ListVirtualNodePoolsRequest request)

Creates a new iterable which will iterate over the responses received from the listVirtualNodePools 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.

listVirtualNodePoolsRecordIterator

public Iterable<VirtualNodePoolSummary> listVirtualNodePoolsRecordIterator(ListVirtualNodePoolsRequest request)

Creates a new iterable which will iterate over the VirtualNodePoolSummary objects contained in responses from the listVirtualNodePools 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 VirtualNodePoolSummary objects contained in responses received from the service.

listVirtualNodesResponseIterator

public Iterable<ListVirtualNodesResponse> listVirtualNodesResponseIterator(ListVirtualNodesRequest request)

Creates a new iterable which will iterate over the responses received from the listVirtualNodes 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.

listVirtualNodesRecordIterator

public Iterable<VirtualNodeSummary> listVirtualNodesRecordIterator(ListVirtualNodesRequest request)

Creates a new iterable which will iterate over the VirtualNodeSummary objects contained in responses from the listVirtualNodes 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 VirtualNodeSummary 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 the WorkRequestSummary 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 the WorkRequestSummary objects contained in responses received from the service.

listWorkloadMappingsResponseIterator

public Iterable<ListWorkloadMappingsResponse> listWorkloadMappingsResponseIterator(ListWorkloadMappingsRequest request)

Creates a new iterable which will iterate over the responses received from the listWorkloadMappings 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.

listWorkloadMappingsRecordIterator

public Iterable<WorkloadMappingSummary> listWorkloadMappingsRecordIterator(ListWorkloadMappingsRequest request)

Creates a new iterable which will iterate over the WorkloadMappingSummary objects contained in responses from the listWorkloadMappings 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 WorkloadMappingSummary objects contained in responses received from the service.