Package com.azure.data.cosmos

Class CosmosStoredProcedure

java.lang.Object

com.azure.data.cosmos.CosmosStoredProcedure

public class CosmosStoredProcedure
extends Object

Method Summary

Modifier and Type	Method	Description
Mono<CosmosResponse>	delete()	Deletes a stored procedure by the stored procedure link.
Mono<CosmosResponse>	delete(CosmosStoredProcedureRequestOptions options)	Deletes a stored procedure by the stored procedure link.
Mono<CosmosStoredProcedureResponse>	execute(Object[] procedureParams, CosmosStoredProcedureRequestOptions options)	Executes a stored procedure by the stored procedure link.
String	id()	Get the id of the CosmosStoredProcedure
Mono<CosmosStoredProcedureResponse>	read()	Read a stored procedure by the stored procedure link.
Mono<CosmosStoredProcedureResponse>	read(CosmosStoredProcedureRequestOptions options)	Read a stored procedure by the stored procedure link.
Mono<CosmosStoredProcedureResponse>	replace(CosmosStoredProcedureProperties storedProcedureSettings)	Replaces a stored procedure.
Mono<CosmosStoredProcedureResponse>	replace(CosmosStoredProcedureProperties storedProcedureSettings, CosmosStoredProcedureRequestOptions options)	Replaces a stored procedure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public String id()

Get the id of the CosmosStoredProcedure

Returns:

the id of the CosmosStoredProcedure

read

public Mono<CosmosStoredProcedureResponse> read()

Read a stored procedure by the stored procedure link.

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<CosmosStoredProcedureResponse> read(CosmosStoredProcedureRequestOptions options)

Read a stored procedure by the stored procedure link.

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.

delete

public Mono<CosmosResponse> delete()

Deletes a stored procedure by the stored procedure link.

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<CosmosResponse> delete(CosmosStoredProcedureRequestOptions options)

Deletes a stored procedure by the stored procedure link.

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<CosmosStoredProcedureResponse> execute(Object[] procedureParams,
                                                   CosmosStoredProcedureRequestOptions options)

Executes a stored procedure by the stored procedure link.

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 array of procedure parameter values.

options - the request options.

Returns:

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

replace

public Mono<CosmosStoredProcedureResponse> replace(CosmosStoredProcedureProperties storedProcedureSettings)

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:

storedProcedureSettings - the stored procedure properties

Returns:

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

replace

public Mono<CosmosStoredProcedureResponse> replace(CosmosStoredProcedureProperties storedProcedureSettings,
                                                   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:

storedProcedureSettings - the stored procedure properties.

options - the request options.

Returns:

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