Class StoredProcedureExecuteResponse<T>

Namespace

Microsoft.Azure.Cosmos.Scripts

Assembly

Microsoft.Azure.Cosmos.Client.dll

The cosmos stored procedure response

public class StoredProcedureExecuteResponse<T> : Response<T>

Type Parameters

T

Inheritance

object

Response<T>

StoredProcedureExecuteResponse<T>

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

StoredProcedureExecuteResponse()

Create a StoredProcedureExecuteResponse<T> as a no-op for mock testing

protected StoredProcedureExecuteResponse()

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

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

Property Value

T

ScriptLog

Gets the output from stored procedure console.log() statements.

public virtual string ScriptLog { get; }

Property Value

string

Output from console.log() statements in a stored procedure.

See Also

EnableScriptLogging

SessionToken

Gets the token for use with session consistency requests from the Azure Cosmos DB service.

public virtual string SessionToken { get; }

Property Value

string

The token for use with session consistency requests.

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