Class DnsPaginators

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

DnsPaginators

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DnsService

Assembly: OCI.DotNetSDK.Dns.dll

Syntax

public class DnsPaginators

Constructors

DnsPaginators(DnsClient)

Declaration

public DnsPaginators(DnsClient client)

Parameters

Type	Name	Description
DnsClient	client

Methods

GetDomainRecordsRecordEnumerator(GetDomainRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<Record> GetDomainRecordsRecordEnumerator(GetDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

GetDomainRecordsResponseEnumerator(GetDomainRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GetDomainRecordsResponse> GetDomainRecordsResponseEnumerator(GetDomainRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

GetRRSetRecordEnumerator(GetRRSetRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<Record> GetRRSetRecordEnumerator(GetRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

GetRRSetResponseEnumerator(GetRRSetRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GetRRSetResponse> GetRRSetResponseEnumerator(GetRRSetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

GetZoneRecordsRecordEnumerator(GetZoneRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<Record> GetZoneRecordsRecordEnumerator(GetZoneRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

GetZoneRecordsResponseEnumerator(GetZoneRecordsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<GetZoneRecordsResponse> GetZoneRecordsResponseEnumerator(GetZoneRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListResolverEndpointsRecordEnumerator(ListResolverEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ResolverEndpointSummary> ListResolverEndpointsRecordEnumerator(ListResolverEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListResolverEndpointsResponseEnumerator(ListResolverEndpointsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListResolverEndpointsResponse> ListResolverEndpointsResponseEnumerator(ListResolverEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListResolversRecordEnumerator(ListResolversRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ResolverSummary> ListResolversRecordEnumerator(ListResolversRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListResolversResponseEnumerator(ListResolversRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListResolversResponse> ListResolversResponseEnumerator(ListResolversRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSteeringPoliciesRecordEnumerator(ListSteeringPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SteeringPolicySummary> ListSteeringPoliciesRecordEnumerator(ListSteeringPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSteeringPoliciesResponseEnumerator(ListSteeringPoliciesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSteeringPoliciesResponse> ListSteeringPoliciesResponseEnumerator(ListSteeringPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSteeringPolicyAttachmentsRecordEnumerator(ListSteeringPolicyAttachmentsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<SteeringPolicyAttachmentSummary> ListSteeringPolicyAttachmentsRecordEnumerator(ListSteeringPolicyAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListSteeringPolicyAttachmentsResponseEnumerator(ListSteeringPolicyAttachmentsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListSteeringPolicyAttachmentsResponse> ListSteeringPolicyAttachmentsResponseEnumerator(ListSteeringPolicyAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTsigKeysRecordEnumerator(ListTsigKeysRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<TsigKeySummary> ListTsigKeysRecordEnumerator(ListTsigKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListTsigKeysResponseEnumerator(ListTsigKeysRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListTsigKeysResponse> ListTsigKeysResponseEnumerator(ListTsigKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListViewsRecordEnumerator(ListViewsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ViewSummary> ListViewsRecordEnumerator(ListViewsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListViewsResponseEnumerator(ListViewsRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListViewsResponse> ListViewsResponseEnumerator(ListViewsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZoneTransferServersRecordEnumerator(ListZoneTransferServersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ZoneTransferServer> ListZoneTransferServersRecordEnumerator(ListZoneTransferServersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZoneTransferServersResponseEnumerator(ListZoneTransferServersRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZoneTransferServersResponse> ListZoneTransferServersResponseEnumerator(ListZoneTransferServersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZonesRecordEnumerator(ListZonesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ZoneSummary> ListZonesRecordEnumerator(ListZonesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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

ListZonesResponseEnumerator(ListZonesRequest, RetryConfiguration, CancellationToken)

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

Declaration

public IEnumerable<ListZonesResponse> ListZonesResponseEnumerator(ListZonesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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