Class MediaServicesPaginators

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

Constructors

MediaServicesPaginators(MediaServicesClient)

Declaration
public MediaServicesPaginators(MediaServicesClient client)
Parameters
Type Name Description
MediaServicesClient client

Methods

ListMediaAssetDistributionChannelAttachmentsRecordEnumerator(ListMediaAssetDistributionChannelAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaAssetDistributionChannelAttachmentsResponseEnumerator(ListMediaAssetDistributionChannelAttachmentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaAssetsRecordEnumerator(ListMediaAssetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaAssetsResponseEnumerator(ListMediaAssetsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowConfigurationsRecordEnumerator(ListMediaWorkflowConfigurationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowConfigurationsResponseEnumerator(ListMediaWorkflowConfigurationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowJobsRecordEnumerator(ListMediaWorkflowJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowJobsResponseEnumerator(ListMediaWorkflowJobsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowTaskDeclarationsRecordEnumerator(ListMediaWorkflowTaskDeclarationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowTaskDeclarationsResponseEnumerator(ListMediaWorkflowTaskDeclarationsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowsRecordEnumerator(ListMediaWorkflowsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMediaWorkflowsResponseEnumerator(ListMediaWorkflowsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamCdnConfigsRecordEnumerator(ListStreamCdnConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamCdnConfigsResponseEnumerator(ListStreamCdnConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamDistributionChannelsRecordEnumerator(ListStreamDistributionChannelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamDistributionChannelsResponseEnumerator(ListStreamDistributionChannelsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamPackagingConfigsRecordEnumerator(ListStreamPackagingConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListStreamPackagingConfigsResponseEnumerator(ListStreamPackagingConfigsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSystemMediaWorkflowsRecordEnumerator(ListSystemMediaWorkflowsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListSystemMediaWorkflowsResponseEnumerator(ListSystemMediaWorkflowsRequest, RetryConfiguration, CancellationToken)

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

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

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