Class ContainerResponse

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

The cosmos container response

public class ContainerResponse : Response<ContainerProperties>

Inheritance

object

Response<ContainerProperties>

ContainerResponse

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

ContainerResponse()

Create a ContainerResponse as a no-op for mock testing

protected ContainerResponse()

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.

Container

The reference to the cosmos container. This allows additional operations on the container or for easy access to other references like Items, StoredProcedures, etc..

public virtual Container Container { get; }

Property Value

Container

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

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 ContainerProperties Resource { get; }

Property Value

ContainerProperties

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 Container(ContainerResponse)

Get Container implicitly from ContainerResponse

public static implicit operator Container(ContainerResponse response)

Parameters

response ContainerResponse

ContainerResponse

Returns

Container