Class ManagementAgentPaginators

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

Constructors

ManagementAgentPaginators(ManagementAgentClient)

Declaration
public ManagementAgentPaginators(ManagementAgentClient client)
Parameters
Type Name Description
ManagementAgentClient client

Methods

ListAvailabilityHistoriesRecordEnumerator(ListAvailabilityHistoriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAvailabilityHistoriesResponseEnumerator(ListAvailabilityHistoriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataSourcesRecordEnumerator(ListDataSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListDataSourcesResponseEnumerator(ListDataSourcesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentImagesRecordEnumerator(ListManagementAgentImagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentImagesResponseEnumerator(ListManagementAgentImagesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentInstallKeysRecordEnumerator(ListManagementAgentInstallKeysRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentInstallKeysResponseEnumerator(ListManagementAgentInstallKeysRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentPluginsRecordEnumerator(ListManagementAgentPluginsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentPluginsResponseEnumerator(ListManagementAgentPluginsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentsRecordEnumerator(ListManagementAgentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListManagementAgentsResponseEnumerator(ListManagementAgentsRequest, RetryConfiguration, CancellationToken)

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

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

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