Class StackMonitoringPaginators

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

Constructors

StackMonitoringPaginators(StackMonitoringClient)

Declaration
public StackMonitoringPaginators(StackMonitoringClient client)
Parameters
Type Name Description
StackMonitoringClient client

Methods

ListBaselineableMetricsRecordEnumerator(ListBaselineableMetricsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBaselineableMetricsResponseEnumerator(ListBaselineableMetricsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConfigsRecordEnumerator(ListConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListConfigsResponseEnumerator(ListConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDiscoveryJobLogsRecordEnumerator(ListDiscoveryJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDiscoveryJobLogsResponseEnumerator(ListDiscoveryJobLogsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDiscoveryJobsRecordEnumerator(ListDiscoveryJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDiscoveryJobsResponseEnumerator(ListDiscoveryJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceWindowsRecordEnumerator(ListMaintenanceWindowsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMaintenanceWindowsResponseEnumerator(ListMaintenanceWindowsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMetricExtensionsRecordEnumerator(ListMetricExtensionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMetricExtensionsResponseEnumerator(ListMetricExtensionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourceTasksRecordEnumerator(ListMonitoredResourceTasksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourceTasksResponseEnumerator(ListMonitoredResourceTasksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourceTypesRecordEnumerator(ListMonitoredResourceTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourceTypesResponseEnumerator(ListMonitoredResourceTypesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourcesRecordEnumerator(ListMonitoredResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMonitoredResourcesResponseEnumerator(ListMonitoredResourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListProcessSetsRecordEnumerator(ListProcessSetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListProcessSetsResponseEnumerator(ListProcessSetsRequest, RetryConfiguration, CancellationToken)

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

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

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