ItemRequestOptions.EnableContentResponseOnWrite Property

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: ItemRequestOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the boolean to only return the headers and status code in the Cosmos DB response for write item operation like Create, Upsert, Patch and Replace. Setting the option to false will cause the response to have a null resource. This reduces networking and CPU load by not sending the resource back over the network and serializing it on the client.

public bool? EnableContentResponseOnWrite { get; set; }

member this.EnableContentResponseOnWrite : Nullable<bool> with get, set

Public Property EnableContentResponseOnWrite As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Examples

ItemRequestOptions requestOptions = new ItemRequestOptions() { EnableContentResponseOnWrite = false };
ItemResponse itemResponse = await this.container.CreateItemAsync<ToDoActivity>(tests, new PartitionKey(test.status), requestOptions);
Assert.AreEqual(HttpStatusCode.Created, itemResponse.StatusCode);
Assert.IsNull(itemResponse.Resource);

Remarks

This is optimal for workloads where the returned resource is not used.

Applies to

Share via