Class WafPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Waf 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
WafPaginators
Inherited Members
Namespace: Oci.WafService
Assembly: OCI.DotNetSDK.Waf.dll
Syntax
public class WafPaginators

Constructors

WafPaginators(WafClient)

Declaration
public WafPaginators(WafClient client)
Parameters
Type Name Description
WafClient client

Methods

ListNetworkAddressListsRecordEnumerator(ListNetworkAddressListsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<NetworkAddressListSummary> ListNetworkAddressListsRecordEnumerator(ListNetworkAddressListsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListNetworkAddressListsRequest 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<NetworkAddressListSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListNetworkAddressListsResponseEnumerator(ListNetworkAddressListsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListNetworkAddressListsResponse> ListNetworkAddressListsResponseEnumerator(ListNetworkAddressListsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListNetworkAddressListsRequest 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<ListNetworkAddressListsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListProtectionCapabilitiesRecordEnumerator(ListProtectionCapabilitiesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ProtectionCapabilitySummary> ListProtectionCapabilitiesRecordEnumerator(ListProtectionCapabilitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProtectionCapabilitiesRequest 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<ProtectionCapabilitySummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListProtectionCapabilitiesResponseEnumerator(ListProtectionCapabilitiesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListProtectionCapabilitiesResponse> ListProtectionCapabilitiesResponseEnumerator(ListProtectionCapabilitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProtectionCapabilitiesRequest 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<ListProtectionCapabilitiesResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListProtectionCapabilityGroupTagsRecordEnumerator(ListProtectionCapabilityGroupTagsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ProtectionCapabilityGroupTagSummary> ListProtectionCapabilityGroupTagsRecordEnumerator(ListProtectionCapabilityGroupTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProtectionCapabilityGroupTagsRequest 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<ProtectionCapabilityGroupTagSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListProtectionCapabilityGroupTagsResponseEnumerator(ListProtectionCapabilityGroupTagsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListProtectionCapabilityGroupTagsResponse> ListProtectionCapabilityGroupTagsResponseEnumerator(ListProtectionCapabilityGroupTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListProtectionCapabilityGroupTagsRequest 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<ListProtectionCapabilityGroupTagsResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWebAppFirewallPoliciesRecordEnumerator(ListWebAppFirewallPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<WebAppFirewallPolicySummary> ListWebAppFirewallPoliciesRecordEnumerator(ListWebAppFirewallPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWebAppFirewallPoliciesRequest 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<WebAppFirewallPolicySummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWebAppFirewallPoliciesResponseEnumerator(ListWebAppFirewallPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListWebAppFirewallPoliciesResponse> ListWebAppFirewallPoliciesResponseEnumerator(ListWebAppFirewallPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWebAppFirewallPoliciesRequest 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<ListWebAppFirewallPoliciesResponse>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWebAppFirewallsRecordEnumerator(ListWebAppFirewallsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<WebAppFirewallSummary> ListWebAppFirewallsRecordEnumerator(ListWebAppFirewallsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWebAppFirewallsRequest 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<WebAppFirewallSummary>

The enumerator, which supports a simple iteration over a collection of a specified type

ListWebAppFirewallsResponseEnumerator(ListWebAppFirewallsRequest, RetryConfiguration, CancellationToken)

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

Declaration
public IEnumerable<ListWebAppFirewallsResponse> ListWebAppFirewallsResponseEnumerator(ListWebAppFirewallsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListWebAppFirewallsRequest 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<ListWebAppFirewallsResponse>

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 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