Class ClientEncryptionKeyResponse

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Response from the Cosmos DB service for a ClientEncryptionKey related request.

public class ClientEncryptionKeyResponse : Response<ClientEncryptionKeyProperties>

Inheritance

object

Response<ClientEncryptionKeyProperties>

ClientEncryptionKeyResponse

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

ClientEncryptionKeyResponse()

Creates a client encryption key response as a no-op for mock testing.

protected ClientEncryptionKeyResponse()

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.

ClientEncryptionKey

The reference to the client encryption key that allows additional operations on it.

public virtual ClientEncryptionKey ClientEncryptionKey { get; }

Property Value

ClientEncryptionKey

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

Property Value

ClientEncryptionKeyProperties

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 ClientEncryptionKey(ClientEncryptionKeyResponse)

Get the client encryption key implicitly from an encryption key response.

public static implicit operator ClientEncryptionKey(ClientEncryptionKeyResponse response)

Parameters

response ClientEncryptionKeyResponse

Response from which to get the client encryption key.

Returns

ClientEncryptionKey