com.azure.cosmos

Class CosmosStoredProcedure

java.lang.Object

com.azure.cosmos.CosmosStoredProcedure

public class CosmosStoredProcedure
extends Object

The type Cosmos sync stored procedure.

Constructor Summary

Constructors

Constructor and Description
CosmosStoredProcedure(String id, CosmosContainer container, CosmosAsyncStoredProcedure storedProcedure) Instantiates a new Cosmos sync stored procedure.

Method Summary

Modifier and Type	Method and Description
CosmosStoredProcedureResponse	delete() Delete cosmos stored procedure.
CosmosStoredProcedureResponse	execute(Object[] procedureParams, CosmosStoredProcedureRequestOptions options) Execute cosmos sync stored procedure.
String	getId() Id string.
CosmosStoredProcedureResponse	read() Read cosmos sync stored procedure.
CosmosStoredProcedureResponse	read(CosmosStoredProcedureRequestOptions options) Read cosmos sync stored procedure.
CosmosStoredProcedureResponse	replace(CosmosStoredProcedureProperties storedProcedureSettings) Replace cosmos sync stored procedure.
CosmosStoredProcedureResponse	replace(CosmosStoredProcedureProperties storedProcedureSettings, CosmosStoredProcedureRequestOptions options) Replace cosmos sync stored procedure.

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosStoredProcedure

public CosmosStoredProcedure(String id,
                             CosmosContainer container,
                             CosmosAsyncStoredProcedure storedProcedure)

Instantiates a new Cosmos sync stored procedure.

Parameters:

id - the id

container - the container

storedProcedure - the stored procedure

Method Detail

getId

public String getId()

Id string.

Returns:

the string

read

public CosmosStoredProcedureResponse read()
                                   throws CosmosClientException

Read cosmos sync stored procedure.

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception

read

public CosmosStoredProcedureResponse read(CosmosStoredProcedureRequestOptions options)
                                   throws CosmosClientException

Read cosmos sync stored procedure.

Parameters:

options - the options

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception

delete

public CosmosStoredProcedureResponse delete()
                                     throws CosmosClientException

Delete cosmos stored procedure.

Returns:

the cosmos sync response

Throws:

CosmosClientException - the cosmos client exception

execute

public CosmosStoredProcedureResponse execute(Object[] procedureParams,
                                             CosmosStoredProcedureRequestOptions options)
                                      throws CosmosClientException

Execute cosmos sync stored procedure.

Parameters:

procedureParams - the procedure params

options - the options

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception

replace

public CosmosStoredProcedureResponse replace(CosmosStoredProcedureProperties storedProcedureSettings)
                                      throws CosmosClientException

Replace cosmos sync stored procedure.

Parameters:

storedProcedureSettings - the stored procedure settings

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception

replace

public CosmosStoredProcedureResponse replace(CosmosStoredProcedureProperties storedProcedureSettings,
                                             CosmosStoredProcedureRequestOptions options)
                                      throws CosmosClientException

Replace cosmos sync stored procedure.

Parameters:

storedProcedureSettings - the stored procedure settings

options - the options

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception