Class ThroughputResponse

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

The cosmos throughput response

public class ThroughputResponse : Response<ThroughputProperties>

Inheritance

object

Response<ThroughputProperties>

ThroughputResponse

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsPrimitive(object)

Constructors

ThroughputResponse()

Create a ThroughputResponse as a no-op for mock testing

protected ThroughputResponse()

Properties

ActivityId

Gets the activity ID for the request from the Azure Cosmos DB service.

public override string ActivityId { get; }

Property Value

string

The activity ID for the request.

Diagnostics

Gets the cosmos diagnostics information for the current request to Azure Cosmos DB service

public override CosmosDiagnostics Diagnostics { get; }

Property Value

CosmosDiagnostics

ETag

Gets the entity tag associated with the resource from the Azure Cosmos DB service.

public override string ETag { get; }

Property Value

string

The entity tag associated with the resource.

Remarks

ETags are used for concurrency checking when updating resources.

Headers

Gets the current ResponseMessage HTTP headers.

public override Headers Headers { get; }

Property Value

Headers

IsReplacePending

Gets the status whether offer replace is successful or pending.

public bool? IsReplacePending { get; }

Property Value

bool?

MinThroughput

Gets minimum throughput in measurement of request units per second in the Azure Cosmos service.

public int? MinThroughput { get; }

Property Value

int?

RequestCharge

Gets the request charge for this request from the Azure Cosmos DB service.

public override double RequestCharge { get; }

Property Value

double

The request charge measured in request units.

Resource

The content of the response.

public override ThroughputProperties Resource { get; }

Property Value

ThroughputProperties

StatusCode

Gets the request completion status code from the Azure Cosmos DB service. This can be used to in scenario like CreateDatabaseIfNotExists to help determine if the database was created or already existed.

public override HttpStatusCode StatusCode { get; }

Property Value

HttpStatusCode

The request completion status code

Remarks

This is only used for success scenarios. The operation will throw a CosmosException on failures. For more info: https://aka.ms/cosmosdb-dot-net-exceptions

Operators

implicit operator ThroughputProperties(ThroughputResponse)

Get ThroughputProperties implicitly from ThroughputResponse

public static implicit operator ThroughputProperties(ThroughputResponse response)

Parameters

response ThroughputResponse

Throughput response

Returns

ThroughputProperties