Show / Hide Table of Contents

Class JavaDownloadPaginators

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

Constructors

JavaDownloadPaginators(JavaDownloadClient)

Declaration
public JavaDownloadPaginators(JavaDownloadClient client)
Parameters
Type Name Description
JavaDownloadClient client

Methods

ListJavaDownloadRecordsRecordEnumerator(ListJavaDownloadRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaDownloadRecordsResponseEnumerator(ListJavaDownloadRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaDownloadReportsRecordEnumerator(ListJavaDownloadReportsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaDownloadReportsResponseEnumerator(ListJavaDownloadReportsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaDownloadTokensRecordEnumerator(ListJavaDownloadTokensRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaDownloadTokensResponseEnumerator(ListJavaDownloadTokensRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaLicenseAcceptanceRecordsRecordEnumerator(ListJavaLicenseAcceptanceRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaLicenseAcceptanceRecordsResponseEnumerator(ListJavaLicenseAcceptanceRecordsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaLicensesRecordEnumerator(ListJavaLicensesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListJavaLicensesResponseEnumerator(ListJavaLicensesRequest, RetryConfiguration, CancellationToken)

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

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

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