Class LoadBalancerPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of LoadBalancer where multiple pages of data may be fetched. Two styles of enumerators are supported:

• Enumerating over the Response objects returned by the list operation. These are referred to as ResponseEnumerators, and the methods are suffixed with ResponseEnumerator. For example: listUsersResponseEnumerator.
• Enumerating over the resources/records being listed. These are referred to as RecordEnumerators, and the methods are suffixed with RecordEnumerator. For example: listUsersRecordEnumerator.

These enumerators 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 iterator returned by calling a ResponseEnumerator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the enumerables returned by calling a RecordEnumerator 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.

Inheritance

object

LoadBalancerPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoadbalancerService

Assembly: OCI.DotNetSDK.Loadbalancer.dll

Syntax

public class LoadBalancerPaginators

Constructors

LoadBalancerPaginators(LoadBalancerClient)

Declaration

public LoadBalancerPaginators(LoadBalancerClient client)

Parameters

Type	Name	Description
LoadBalancerClient	client

Methods

ListLoadBalancerHealthsRecordEnumerator(ListLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the LoadBalancerHealthSummary objects contained in responses from the ListLoadBalancerHealths operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<LoadBalancerHealthSummary> ListLoadBalancerHealthsRecordEnumerator(ListLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListLoadBalancerHealthsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<LoadBalancerHealthSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListLoadBalancerHealthsResponseEnumerator(ListLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListLoadBalancerHealths operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListLoadBalancerHealthsResponse> ListLoadBalancerHealthsResponseEnumerator(ListLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListLoadBalancerHealthsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListLoadBalancerHealthsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListLoadBalancersRecordEnumerator(ListLoadBalancersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the LoadBalancer objects contained in responses from the ListLoadBalancers operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<LoadBalancer> ListLoadBalancersRecordEnumerator(ListLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListLoadBalancersRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<LoadBalancer>	The enumerator, which supports a simple iteration over a collection of a specified type

ListLoadBalancersResponseEnumerator(ListLoadBalancersRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListLoadBalancers operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListLoadBalancersResponse> ListLoadBalancersResponseEnumerator(ListLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListLoadBalancersRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListLoadBalancersResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPoliciesRecordEnumerator(ListPoliciesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the LoadBalancerPolicy objects contained in responses from the ListPolicies operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<LoadBalancerPolicy> ListPoliciesRecordEnumerator(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPoliciesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<LoadBalancerPolicy>	The enumerator, which supports a simple iteration over a collection of a specified type

ListPoliciesResponseEnumerator(ListPoliciesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListPolicies operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListPoliciesResponse> ListPoliciesResponseEnumerator(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListPoliciesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListPoliciesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListProtocolsRecordEnumerator(ListProtocolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the LoadBalancerProtocol objects contained in responses from the ListProtocols operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<LoadBalancerProtocol> ListProtocolsRecordEnumerator(ListProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListProtocolsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<LoadBalancerProtocol>	The enumerator, which supports a simple iteration over a collection of a specified type

ListProtocolsResponseEnumerator(ListProtocolsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListProtocols operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListProtocolsResponse> ListProtocolsResponseEnumerator(ListProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListProtocolsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListProtocolsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRoutingPoliciesRecordEnumerator(ListRoutingPoliciesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the RoutingPolicy objects contained in responses from the ListRoutingPolicies operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<RoutingPolicy> ListRoutingPoliciesRecordEnumerator(ListRoutingPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRoutingPoliciesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<RoutingPolicy>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRoutingPoliciesResponseEnumerator(ListRoutingPoliciesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListRoutingPolicies operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListRoutingPoliciesResponse> ListRoutingPoliciesResponseEnumerator(ListRoutingPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRoutingPoliciesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListRoutingPoliciesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListShapesRecordEnumerator(ListShapesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the LoadBalancerShape objects contained in responses from the ListShapes operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<LoadBalancerShape> ListShapesRecordEnumerator(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListShapesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<LoadBalancerShape>	The enumerator, which supports a simple iteration over a collection of a specified type

ListShapesResponseEnumerator(ListShapesRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListShapes operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListShapesResponse> ListShapesResponseEnumerator(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListShapesRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListShapesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the WorkRequest objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<WorkRequest> ListWorkRequestsRecordEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<WorkRequest>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest, RetryConfiguration, CancellationToken)

Creates a new enumerable which will iterate over the responses received from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<ListWorkRequestsResponse> ListWorkRequestsResponseEnumerator(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send
RetryConfiguration	retryConfiguration	The configuration for retrying, may be null
CancellationToken	cancellationToken	The cancellation token object

Returns

Type	Description
IEnumerable<ListWorkRequestsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type