Class ServiceMeshPaginators

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

Constructors

ServiceMeshPaginators(ServiceMeshClient)

Declaration
public ServiceMeshPaginators(ServiceMeshClient client)
Parameters
Type Name Description
ServiceMeshClient client

Methods

ListAccessPoliciesRecordEnumerator(ListAccessPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListAccessPoliciesResponseEnumerator(ListAccessPoliciesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIngressGatewayRouteTablesRecordEnumerator(ListIngressGatewayRouteTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIngressGatewayRouteTablesResponseEnumerator(ListIngressGatewayRouteTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIngressGatewaysRecordEnumerator(ListIngressGatewaysRequest, RetryConfiguration, CancellationToken)

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

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

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

ListIngressGatewaysResponseEnumerator(ListIngressGatewaysRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMeshesRecordEnumerator(ListMeshesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListMeshesResponseEnumerator(ListMeshesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualDeploymentsRecordEnumerator(ListVirtualDeploymentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualDeploymentsResponseEnumerator(ListVirtualDeploymentsRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualServiceRouteTablesRecordEnumerator(ListVirtualServiceRouteTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualServiceRouteTablesResponseEnumerator(ListVirtualServiceRouteTablesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualServicesRecordEnumerator(ListVirtualServicesRequest, RetryConfiguration, CancellationToken)

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

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

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

ListVirtualServicesResponseEnumerator(ListVirtualServicesRequest, RetryConfiguration, CancellationToken)

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

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

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