IJournalStorage.UpdateMetadataAsync(IReadOnlyDictionary<string, string>, IEnumerable<string>, string?, CancellationToken)

1. Documentation
2. API reference
3. Microsoft.Orleans.Journaling
4. IJournalStorage
5. Methods
6. UpdateMetadataAsync(IReadOnlyDictionary<string, string>, IEnumerable<string>, string?, CancellationToken)

Markdown

UpdateMetadataAsync(IReadOnlyDictionary<string, string>, IEnumerable<string>, string?, CancellationToken)

virtual

View source

public virtual ValueTask<IJournalMetadata?> UpdateMetadataAsync(IReadOnlyDictionary<string, string>? set = null, IEnumerable<string>? remove = null, string? expectedETag = null, CancellationToken cancellationToken = default(CancellationToken))

Conditionally updates caller-owned metadata properties.

Parameters

setIReadOnlyDictionary<string, string>

Metadata properties to set.

removeIEnumerable<string>

Metadata properties to remove.

expectedETagstring?

The expected metadata ETag, or null for an unconditional update.

cancellationTokenCancellationToken

The cancellation token.

Returns

The current metadata if the update was applied or made no changes; otherwise, null.