Class NetworkLoadBalancerPaginators

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

NetworkLoadBalancerPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.NetworkloadbalancerService

Assembly: OCI.DotNetSDK.Networkloadbalancer.dll

Syntax

public class NetworkLoadBalancerPaginators

Constructors

NetworkLoadBalancerPaginators(NetworkLoadBalancerClient)

Declaration

public NetworkLoadBalancerPaginators(NetworkLoadBalancerClient client)

Parameters

Type	Name	Description
NetworkLoadBalancerClient	client

Methods

ListBackendSetsRecordEnumerator(ListBackendSetsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<BackendSetSummary> ListBackendSetsRecordEnumerator(ListBackendSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListBackendSetsRequest	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<BackendSetSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListBackendSetsResponseEnumerator(ListBackendSetsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListBackendSetsResponse> ListBackendSetsResponseEnumerator(ListBackendSetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListBackendSetsRequest	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<ListBackendSetsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListBackendsRecordEnumerator(ListBackendsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<BackendSummary> ListBackendsRecordEnumerator(ListBackendsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListBackendsRequest	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<BackendSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListBackendsResponseEnumerator(ListBackendsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListBackendsResponse> ListBackendsResponseEnumerator(ListBackendsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListBackendsRequest	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<ListBackendsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListListenersRecordEnumerator(ListListenersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListenerSummary> ListListenersRecordEnumerator(ListListenersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListListenersRequest	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<ListenerSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListListenersResponseEnumerator(ListListenersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListListenersResponse> ListListenersResponseEnumerator(ListListenersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListListenersRequest	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<ListListenersResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancerHealthsRecordEnumerator(ListNetworkLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<NetworkLoadBalancerHealthSummary> ListNetworkLoadBalancerHealthsRecordEnumerator(ListNetworkLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancerHealthsRequest	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<NetworkLoadBalancerHealthSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancerHealthsResponseEnumerator(ListNetworkLoadBalancerHealthsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListNetworkLoadBalancerHealthsResponse> ListNetworkLoadBalancerHealthsResponseEnumerator(ListNetworkLoadBalancerHealthsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancerHealthsRequest	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<ListNetworkLoadBalancerHealthsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersPoliciesRecordEnumerator(ListNetworkLoadBalancersPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<NetworkLoadBalancersPolicySummary> ListNetworkLoadBalancersPoliciesRecordEnumerator(ListNetworkLoadBalancersPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersPoliciesRequest	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<NetworkLoadBalancersPolicySummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersPoliciesResponseEnumerator(ListNetworkLoadBalancersPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListNetworkLoadBalancersPoliciesResponse> ListNetworkLoadBalancersPoliciesResponseEnumerator(ListNetworkLoadBalancersPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersPoliciesRequest	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<ListNetworkLoadBalancersPoliciesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersProtocolsRecordEnumerator(ListNetworkLoadBalancersProtocolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<NetworkLoadBalancersProtocolSummary> ListNetworkLoadBalancersProtocolsRecordEnumerator(ListNetworkLoadBalancersProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersProtocolsRequest	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<NetworkLoadBalancersProtocolSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersProtocolsResponseEnumerator(ListNetworkLoadBalancersProtocolsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListNetworkLoadBalancersProtocolsResponse> ListNetworkLoadBalancersProtocolsResponseEnumerator(ListNetworkLoadBalancersProtocolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersProtocolsRequest	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<ListNetworkLoadBalancersProtocolsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersRecordEnumerator(ListNetworkLoadBalancersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<NetworkLoadBalancerSummary> ListNetworkLoadBalancersRecordEnumerator(ListNetworkLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersRequest	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<NetworkLoadBalancerSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkLoadBalancersResponseEnumerator(ListNetworkLoadBalancersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListNetworkLoadBalancersResponse> ListNetworkLoadBalancersResponseEnumerator(ListNetworkLoadBalancersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListNetworkLoadBalancersRequest	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<ListNetworkLoadBalancersResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<WorkRequestError> ListWorkRequestErrorsRecordEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	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<WorkRequestError>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListWorkRequestErrorsResponse> ListWorkRequestErrorsResponseEnumerator(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	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<ListWorkRequestErrorsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<WorkRequestLogEntry> ListWorkRequestLogsRecordEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	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<WorkRequestLogEntry>	The enumerator, which supports a simple iteration over a collection of a specified type

ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListWorkRequestLogsResponse> ListWorkRequestLogsResponseEnumerator(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	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<ListWorkRequestLogsResponse>	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 WorkRequestSummary objects contained in responses from the ListWorkRequests operation. This enumerable will fetch more data from the server as needed.

Declaration

public IEnumerable<WorkRequestSummary> 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<WorkRequestSummary>	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