Class HealthChecksPaginators

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

HealthChecksPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.HealthchecksService

Assembly: OCI.DotNetSDK.Healthchecks.dll

Syntax

public class HealthChecksPaginators

Constructors

HealthChecksPaginators(HealthChecksClient)

Declaration

public HealthChecksPaginators(HealthChecksClient client)

Parameters

Type	Name	Description
HealthChecksClient	client

Methods

ListHealthChecksVantagePointsRecordEnumerator(ListHealthChecksVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<HealthChecksVantagePointSummary> ListHealthChecksVantagePointsRecordEnumerator(ListHealthChecksVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListHealthChecksVantagePointsResponseEnumerator(ListHealthChecksVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListHealthChecksVantagePointsResponse> ListHealthChecksVantagePointsResponseEnumerator(ListHealthChecksVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListHttpMonitorsRecordEnumerator(ListHttpMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<HttpMonitorSummary> ListHttpMonitorsRecordEnumerator(ListHttpMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListHttpMonitorsResponseEnumerator(ListHttpMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListHttpMonitorsResponse> ListHttpMonitorsResponseEnumerator(ListHttpMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListHttpProbeResultsRecordEnumerator(ListHttpProbeResultsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<HttpProbeResultSummary> ListHttpProbeResultsRecordEnumerator(ListHttpProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListHttpProbeResultsResponseEnumerator(ListHttpProbeResultsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListHttpProbeResultsResponse> ListHttpProbeResultsResponseEnumerator(ListHttpProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPingMonitorsRecordEnumerator(ListPingMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<PingMonitorSummary> ListPingMonitorsRecordEnumerator(ListPingMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPingMonitorsResponseEnumerator(ListPingMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListPingMonitorsResponse> ListPingMonitorsResponseEnumerator(ListPingMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPingProbeResultsRecordEnumerator(ListPingProbeResultsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<PingProbeResultSummary> ListPingProbeResultsRecordEnumerator(ListPingProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPingProbeResultsResponseEnumerator(ListPingProbeResultsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListPingProbeResultsResponse> ListPingProbeResultsResponseEnumerator(ListPingProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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