Class BatchComputingPaginators

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

Constructors

BatchComputingPaginators(BatchComputingClient)

Declaration
public BatchComputingPaginators(BatchComputingClient client)
Parameters
Type Name Description
BatchComputingClient client

Methods

ListBatchContextShapesRecordEnumerator(ListBatchContextShapesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchContextShapesResponseEnumerator(ListBatchContextShapesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchContextsRecordEnumerator(ListBatchContextsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchContextsResponseEnumerator(ListBatchContextsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobPoolsRecordEnumerator(ListBatchJobPoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobPoolsResponseEnumerator(ListBatchJobPoolsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobTasksRecordEnumerator(ListBatchJobTasksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobTasksResponseEnumerator(ListBatchJobTasksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobsRecordEnumerator(ListBatchJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchJobsResponseEnumerator(ListBatchJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTaskEnvironmentsRecordEnumerator(ListBatchTaskEnvironmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTaskEnvironmentsResponseEnumerator(ListBatchTaskEnvironmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTaskProfilesRecordEnumerator(ListBatchTaskProfilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTaskProfilesResponseEnumerator(ListBatchTaskProfilesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTasksRecordEnumerator(ListBatchTasksRequest, RetryConfiguration, CancellationToken)

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

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

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

ListBatchTasksResponseEnumerator(ListBatchTasksRequest, RetryConfiguration, CancellationToken)

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

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

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