Class ListIndexesUsingCommandOperation

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents a list indexes operation.

public class ListIndexesUsingCommandOperation : IReadOperation<IAsyncCursor<BsonDocument>>, IExecutableInRetryableReadContext<IAsyncCursor<BsonDocument>>

Inheritance

object

ListIndexesUsingCommandOperation

Implements

IReadOperation<IAsyncCursor<BsonDocument>>

IExecutableInRetryableReadContext<IAsyncCursor<BsonDocument>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

OperationExtensionMethods.ExecuteAsync<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

OperationExtensionMethods.Execute<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

Constructors

ListIndexesUsingCommandOperation(CollectionNamespace, MessageEncoderSettings)

Initializes a new instance of the ListIndexesUsingCommandOperation class.

public ListIndexesUsingCommandOperation(CollectionNamespace collectionNamespace, MessageEncoderSettings messageEncoderSettings)

Parameters

collectionNamespace CollectionNamespace

The collection namespace.

messageEncoderSettings MessageEncoderSettings

The message encoder settings.

Properties

BatchSize

Gets or sets the batch size.

public int? BatchSize { get; set; }

Property Value

int?

The batch size.

CollectionNamespace

Gets the collection namespace.

public CollectionNamespace CollectionNamespace { get; }

Property Value

CollectionNamespace

The collection namespace.

Comment

Gets or sets the comment.

public BsonValue Comment { get; set; }

Property Value

BsonValue

The comment.

MessageEncoderSettings

Gets the message encoder settings.

public MessageEncoderSettings MessageEncoderSettings { get; }

Property Value

MessageEncoderSettings

The message encoder settings.

RetryRequested

Gets or sets whether or not retry was requested.

public bool RetryRequested { get; set; }

Property Value

bool

Whether retry was requested.

Methods

Execute(IReadBinding, CancellationToken)

Executes the operation.

public IAsyncCursor<BsonDocument> Execute(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

The result of the operation.

Execute(RetryableReadContext, CancellationToken)

Executes the first attempt.

public IAsyncCursor<BsonDocument> Execute(RetryableReadContext context, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<BsonDocument>

The result.

ExecuteAsync(IReadBinding, CancellationToken)

Executes the operation.

public Task<IAsyncCursor<BsonDocument>> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

A Task whose result is the result of the operation.

ExecuteAsync(RetryableReadContext, CancellationToken)

Executes the first attempt.

public Task<IAsyncCursor<BsonDocument>> ExecuteAsync(RetryableReadContext context, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<BsonDocument>>

The result.