CosmosAsyncStoredProcedure Class

Package:

com.azure.cosmos

Maven Artifact:

com.azure:azure-cosmos:4.61.1

• java.lang.Object
• • com.azure.cosmos.CosmosAsyncStoredProcedure

public class CosmosAsyncStoredProcedure

The type Cosmos async stored procedure.

Method Summary

Modifier and Type	Method and Description
Mono<CosmosStoredProcedureResponse>	delete() Deletes a stored procedure
Mono<CosmosStoredProcedureResponse>	delete(CosmosStoredProcedureRequestOptions options) Deletes a stored procedure
Mono<CosmosStoredProcedureResponse>	execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options) Executes a stored procedure
String	getId() Get the id of the CosmosAsyncStoredProcedure
Mono<CosmosStoredProcedureResponse>	read() Read a stored procedure
Mono<CosmosStoredProcedureResponse>	read(CosmosStoredProcedureRequestOptions options) Read a stored procedure
Mono<CosmosStoredProcedureResponse>	replace(CosmosStoredProcedureProperties storedProcedureProperties) Replaces a stored procedure.
Mono<CosmosStoredProcedureResponse>	replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options) Replaces a stored procedure.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

delete

public Mono delete()

Deletes a stored procedure

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response for the deleted stored procedure. In case of failure the Mono will error.

Returns:

an Mono containing the single resource response for the deleted stored procedure or an error.

delete

public Mono delete(CosmosStoredProcedureRequestOptions options)

Deletes a stored procedure

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response for the deleted stored procedure. In case of failure the Mono will error.

Parameters:

options - the request options.

Returns:

an Mono containing the single resource response for the deleted stored procedure or an error.

execute

public Mono execute(List

Executes a stored procedure

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the stored procedure response. In case of failure the Mono will error.

Parameters:

procedureParams - the list of procedure parameter values.

options - the request options.

Returns:

an Mono containing the single resource response with the stored procedure response or an error.

getId

public String getId()

Get the id of the CosmosAsyncStoredProcedure

Returns:

the id of the CosmosAsyncStoredProcedure

read

public Mono read()

Read a stored procedure

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the read stored procedure. In case of failure the Mono will error.

Returns:

an Mono containing the single resource response with the read stored procedure or an error.

read

public Mono read(CosmosStoredProcedureRequestOptions options)

Read a stored procedure

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the read stored procedure. In case of failure the Mono will error.

Parameters:

options - the request options.

Returns:

an Mono containing the single resource response with the read stored procedure or an error.

replace

public Mono replace(CosmosStoredProcedureProperties storedProcedureProperties)

Replaces a stored procedure.

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the replaced stored procedure. In case of failure the Mono will error.

Parameters:

storedProcedureProperties - the stored procedure properties

Returns:

an Mono containing the single resource response with the replaced stored procedure or an error.

replace

public Mono replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)

Replaces a stored procedure.

After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the replaced stored procedure. In case of failure the Mono will error.

Parameters:

storedProcedureProperties - the stored procedure properties.

options - the request options.

Returns:

an Mono containing the single resource response with the replaced stored procedure or an error.