Share via

CosmosStoredProcedure Class

Package:
com.azure.cosmos
Maven Artifact:
com.azure:azure-cosmos:4.75.0
  • java.lang.Object
    • com.azure.cosmos.CosmosStoredProcedure

public class CosmosStoredProcedure

The type Cosmos sync stored procedure.

Constructor Summary

Constructor 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(List<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 storedProcedureProperties)

Replace cosmos sync stored procedure.
CosmosStoredProcedureResponse replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)

Replace cosmos sync stored procedure.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

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 Details

delete

public CosmosStoredProcedureResponse delete()

Delete cosmos stored procedure.

Returns:

the cosmos response

execute

public CosmosStoredProcedureResponse execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options)

Execute cosmos sync stored procedure.

Parameters:

procedureParams - the procedure params
options - the options

Returns:

the cosmos stored procedure response

getId

public String getId()

Id string.

Returns:

the string

read

public CosmosStoredProcedureResponse read()

Read cosmos sync stored procedure.

Returns:

the cosmos stored procedure response

read

public CosmosStoredProcedureResponse read(CosmosStoredProcedureRequestOptions options)

Read cosmos sync stored procedure.

Parameters:

options - the options

Returns:

the cosmos stored procedure response

replace

public CosmosStoredProcedureResponse replace(CosmosStoredProcedureProperties storedProcedureProperties)

Replace cosmos sync stored procedure.

Parameters:

storedProcedureProperties - the stored procedure settings

Returns:

the cosmos stored procedure response

replace

public CosmosStoredProcedureResponse replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)

Replace cosmos sync stored procedure.

Parameters:

storedProcedureProperties - the stored procedure settings
options - the options

Returns:

the cosmos stored procedure response

Applies to