Class ArtifactsPaginators

Collection of helper methods that can be used to provide an enumerator interface to any list operations of Artifacts 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

ArtifactsPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ArtifactsService

Assembly: OCI.DotNetSDK.Artifacts.dll

Syntax

public class ArtifactsPaginators

Constructors

ArtifactsPaginators(ArtifactsClient)

Declaration

public ArtifactsPaginators(ArtifactsClient client)

Parameters

Type	Name	Description
ArtifactsClient	client

Methods

ListContainerImageSignaturesRecordEnumerator(ListContainerImageSignaturesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ContainerImageSignatureSummary> ListContainerImageSignaturesRecordEnumerator(ListContainerImageSignaturesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerImageSignaturesRequest	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<ContainerImageSignatureSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListContainerImageSignaturesResponseEnumerator(ListContainerImageSignaturesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListContainerImageSignaturesResponse> ListContainerImageSignaturesResponseEnumerator(ListContainerImageSignaturesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerImageSignaturesRequest	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<ListContainerImageSignaturesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListContainerImagesRecordEnumerator(ListContainerImagesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ContainerImageSummary> ListContainerImagesRecordEnumerator(ListContainerImagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerImagesRequest	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<ContainerImageSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListContainerImagesResponseEnumerator(ListContainerImagesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListContainerImagesResponse> ListContainerImagesResponseEnumerator(ListContainerImagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerImagesRequest	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<ListContainerImagesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListContainerRepositoriesRecordEnumerator(ListContainerRepositoriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ContainerRepositorySummary> ListContainerRepositoriesRecordEnumerator(ListContainerRepositoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerRepositoriesRequest	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<ContainerRepositorySummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListContainerRepositoriesResponseEnumerator(ListContainerRepositoriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListContainerRepositoriesResponse> ListContainerRepositoriesResponseEnumerator(ListContainerRepositoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListContainerRepositoriesRequest	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<ListContainerRepositoriesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListGenericArtifactsRecordEnumerator(ListGenericArtifactsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GenericArtifactSummary> ListGenericArtifactsRecordEnumerator(ListGenericArtifactsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListGenericArtifactsRequest	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<GenericArtifactSummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListGenericArtifactsResponseEnumerator(ListGenericArtifactsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListGenericArtifactsResponse> ListGenericArtifactsResponseEnumerator(ListGenericArtifactsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListGenericArtifactsRequest	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<ListGenericArtifactsResponse>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRepositoriesRecordEnumerator(ListRepositoriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<RepositorySummary> ListRepositoriesRecordEnumerator(ListRepositoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRepositoriesRequest	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<RepositorySummary>	The enumerator, which supports a simple iteration over a collection of a specified type

ListRepositoriesResponseEnumerator(ListRepositoriesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListRepositoriesResponse> ListRepositoriesResponseEnumerator(ListRepositoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListRepositoriesRequest	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<ListRepositoriesResponse>	The enumerator, which supports a simple iteration over a collection of a specified type