Show / Hide Table of Contents

Class FleetSoftwareUpdatePaginators

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

Constructors

FleetSoftwareUpdatePaginators(FleetSoftwareUpdateClient)

Declaration
public FleetSoftwareUpdatePaginators(FleetSoftwareUpdateClient client)
Parameters
Type Name Description
FleetSoftwareUpdateClient client

Methods

ListFsuActionsRecordEnumerator(ListFsuActionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuActionsResponseEnumerator(ListFsuActionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCollectionTargetsRecordEnumerator(ListFsuCollectionTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCollectionTargetsResponseEnumerator(ListFsuCollectionTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCollectionsRecordEnumerator(ListFsuCollectionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCollectionsResponseEnumerator(ListFsuCollectionsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCyclesRecordEnumerator(ListFsuCyclesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuCyclesResponseEnumerator(ListFsuCyclesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuDiscoveriesRecordEnumerator(ListFsuDiscoveriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuDiscoveriesResponseEnumerator(ListFsuDiscoveriesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuDiscoveryTargetsRecordEnumerator(ListFsuDiscoveryTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuDiscoveryTargetsResponseEnumerator(ListFsuDiscoveryTargetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuJobOutputsRecordEnumerator(ListFsuJobOutputsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuJobOutputsResponseEnumerator(ListFsuJobOutputsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuJobsRecordEnumerator(ListFsuJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListFsuJobsResponseEnumerator(ListFsuJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

In this article
Back to top