Class ApmSyntheticPaginators

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

ApmSyntheticPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmsyntheticsService

Assembly: OCI.DotNetSDK.Apmsynthetics.dll

Syntax

public class ApmSyntheticPaginators

Constructors

ApmSyntheticPaginators(ApmSyntheticClient)

Declaration

public ApmSyntheticPaginators(ApmSyntheticClient client)

Parameters

Type	Name	Description
ApmSyntheticClient	client

Methods

ListDedicatedVantagePointsRecordEnumerator(ListDedicatedVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<DedicatedVantagePointSummary> ListDedicatedVantagePointsRecordEnumerator(ListDedicatedVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListDedicatedVantagePointsResponseEnumerator(ListDedicatedVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListDedicatedVantagePointsResponse> ListDedicatedVantagePointsResponseEnumerator(ListDedicatedVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListMonitorsRecordEnumerator(ListMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<MonitorSummary> ListMonitorsRecordEnumerator(ListMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListMonitorsResponseEnumerator(ListMonitorsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListMonitorsResponse> ListMonitorsResponseEnumerator(ListMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListOnPremiseVantagePointsRecordEnumerator(ListOnPremiseVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<OnPremiseVantagePointSummary> ListOnPremiseVantagePointsRecordEnumerator(ListOnPremiseVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListOnPremiseVantagePointsResponseEnumerator(ListOnPremiseVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListOnPremiseVantagePointsResponse> ListOnPremiseVantagePointsResponseEnumerator(ListOnPremiseVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPublicVantagePointsRecordEnumerator(ListPublicVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<PublicVantagePointSummary> ListPublicVantagePointsRecordEnumerator(ListPublicVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListPublicVantagePointsResponseEnumerator(ListPublicVantagePointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListPublicVantagePointsResponse> ListPublicVantagePointsResponseEnumerator(ListPublicVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListScriptsRecordEnumerator(ListScriptsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ScriptSummary> ListScriptsRecordEnumerator(ListScriptsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListScriptsResponseEnumerator(ListScriptsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListScriptsResponse> ListScriptsResponseEnumerator(ListScriptsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListWorkersRecordEnumerator(ListWorkersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<WorkerSummary> ListWorkersRecordEnumerator(ListWorkersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListWorkersResponseEnumerator(ListWorkersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListWorkersResponse> ListWorkersResponseEnumerator(ListWorkersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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