Show / Hide Table of Contents

Class ThreatintelPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Threatintel 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
ThreatintelPaginators
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ThreatintelligenceService
Assembly: OCI.DotNetSDK.Threatintelligence.dll
Syntax
public class ThreatintelPaginators

Constructors

ThreatintelPaginators(ThreatintelClient)

Declaration
public ThreatintelPaginators(ThreatintelClient client)
Parameters
Type Name Description
ThreatintelClient client

Methods

ListIndicatorsRecordEnumerator(ListIndicatorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIndicatorsResponseEnumerator(ListIndicatorsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListThreatTypesRecordEnumerator(ListThreatTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListThreatTypesResponseEnumerator(ListThreatTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top