Package com.azure.data.cosmos.sync

Class CosmosSyncStoredProcedure

java.lang.Object

com.azure.data.cosmos.sync.CosmosSyncStoredProcedure

public class CosmosSyncStoredProcedure
extends Object

The type Cosmos sync stored procedure.

Constructor Summary

Constructors

Constructor	Description
CosmosSyncStoredProcedure(String id, CosmosSyncContainer container, CosmosStoredProcedure storedProcedure)	Instantiates a new Cosmos sync stored procedure.

Method Summary

Modifier and Type	Method	Description
CosmosSyncResponse	delete()	Delete cosmos stored procedure.
CosmosSyncStoredProcedureResponse	execute(Object[] procedureParams, CosmosStoredProcedureRequestOptions options)	Execute cosmos sync stored procedure.
String	id()	Id string.
CosmosSyncStoredProcedureResponse	read()	Read cosmos sync stored procedure.
CosmosSyncStoredProcedureResponse	read(CosmosStoredProcedureRequestOptions options)	Read cosmos sync stored procedure.
CosmosSyncStoredProcedureResponse	replace(CosmosStoredProcedureProperties storedProcedureSettings)	Replace cosmos sync stored procedure.
CosmosSyncStoredProcedureResponse	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

CosmosSyncStoredProcedure

public CosmosSyncStoredProcedure(String id,
                                 CosmosSyncContainer container,
                                 CosmosStoredProcedure storedProcedure)

Instantiates a new Cosmos sync stored procedure.

Parameters:

id - the id

container - the container

storedProcedure - the stored procedure

Method Detail

id

public String id()

Id string.

Returns:

the string

read

public CosmosSyncStoredProcedureResponse read()
                                       throws CosmosClientException

Read cosmos sync stored procedure.

Returns:

the cosmos sync stored procedure response

Throws:

CosmosClientException - the cosmos client exception

read

public CosmosSyncStoredProcedureResponse 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 CosmosSyncResponse delete()
                          throws CosmosClientException

Delete cosmos stored procedure.

Returns:

the cosmos sync response

Throws:

CosmosClientException - the cosmos client exception

execute

public CosmosSyncStoredProcedureResponse 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 CosmosSyncStoredProcedureResponse 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 CosmosSyncStoredProcedureResponse 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