136 строки
15 KiB
YAML
136 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.CosmosAsyncStoredProcedure"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure"
|
|
name: "CosmosAsyncStoredProcedure"
|
|
nameWithType: "CosmosAsyncStoredProcedure"
|
|
summary: "The type Cosmos async stored procedure."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **CosmosAsyncStoredProcedure**"
|
|
methods:
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.delete()"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.delete()"
|
|
name: "delete()"
|
|
nameWithType: "CosmosAsyncStoredProcedure.delete()"
|
|
summary: "Deletes a stored procedure"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> delete()"
|
|
desc: "Deletes a stored procedure\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response for the deleted stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response for the deleted stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.delete(com.azure.cosmos.models.CosmosStoredProcedureRequestOptions)"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.delete(CosmosStoredProcedureRequestOptions options)"
|
|
name: "delete(CosmosStoredProcedureRequestOptions options)"
|
|
nameWithType: "CosmosAsyncStoredProcedure.delete(CosmosStoredProcedureRequestOptions options)"
|
|
summary: "Deletes a stored procedure"
|
|
parameters:
|
|
- description: "the request options."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> delete(CosmosStoredProcedureRequestOptions options)"
|
|
desc: "Deletes a stored procedure\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response for the deleted stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response for the deleted stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.execute(java.util.List<java.lang.Object>,com.azure.cosmos.models.CosmosStoredProcedureRequestOptions)"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options)"
|
|
name: "execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options)"
|
|
nameWithType: "CosmosAsyncStoredProcedure.execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options)"
|
|
summary: "Executes a stored procedure"
|
|
parameters:
|
|
- description: "the list of procedure parameter values."
|
|
name: "procedureParams"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
- description: "the request options."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> execute(List<Object> procedureParams, CosmosStoredProcedureRequestOptions options)"
|
|
desc: "Executes a stored procedure\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the stored procedure response. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the stored procedure response or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.getId()"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.getId()"
|
|
name: "getId()"
|
|
nameWithType: "CosmosAsyncStoredProcedure.getId()"
|
|
summary: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncStoredProcedure\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncStoredProcedure\"></xref>"
|
|
syntax: "public String getId()"
|
|
desc: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncStoredProcedure\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncStoredProcedure\"></xref>"
|
|
returns:
|
|
description: "the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncStoredProcedure\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncStoredProcedure\"></xref>"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.read()"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.read()"
|
|
name: "read()"
|
|
nameWithType: "CosmosAsyncStoredProcedure.read()"
|
|
summary: "Read a stored procedure"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> read()"
|
|
desc: "Read a stored procedure\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the read stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the read stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.read(com.azure.cosmos.models.CosmosStoredProcedureRequestOptions)"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.read(CosmosStoredProcedureRequestOptions options)"
|
|
name: "read(CosmosStoredProcedureRequestOptions options)"
|
|
nameWithType: "CosmosAsyncStoredProcedure.read(CosmosStoredProcedureRequestOptions options)"
|
|
summary: "Read a stored procedure"
|
|
parameters:
|
|
- description: "the request options."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> read(CosmosStoredProcedureRequestOptions options)"
|
|
desc: "Read a stored procedure\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the read stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the read stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.replace(com.azure.cosmos.models.CosmosStoredProcedureProperties)"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.replace(CosmosStoredProcedureProperties storedProcedureProperties)"
|
|
name: "replace(CosmosStoredProcedureProperties storedProcedureProperties)"
|
|
nameWithType: "CosmosAsyncStoredProcedure.replace(CosmosStoredProcedureProperties storedProcedureProperties)"
|
|
summary: "Replaces a stored procedure."
|
|
parameters:
|
|
- description: "the stored procedure properties"
|
|
name: "storedProcedureProperties"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureProperties?alt=com.azure.cosmos.models.CosmosStoredProcedureProperties&text=CosmosStoredProcedureProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> replace(CosmosStoredProcedureProperties storedProcedureProperties)"
|
|
desc: "Replaces a stored procedure.\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the replaced stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the replaced stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosAsyncStoredProcedure.replace(com.azure.cosmos.models.CosmosStoredProcedureProperties,com.azure.cosmos.models.CosmosStoredProcedureRequestOptions)"
|
|
fullName: "com.azure.cosmos.CosmosAsyncStoredProcedure.replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)"
|
|
name: "replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)"
|
|
nameWithType: "CosmosAsyncStoredProcedure.replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)"
|
|
summary: "Replaces a stored procedure."
|
|
parameters:
|
|
- description: "the stored procedure properties."
|
|
name: "storedProcedureProperties"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureProperties?alt=com.azure.cosmos.models.CosmosStoredProcedureProperties&text=CosmosStoredProcedureProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the request options."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<CosmosStoredProcedureResponse> replace(CosmosStoredProcedureProperties storedProcedureProperties, CosmosStoredProcedureRequestOptions options)"
|
|
desc: "Replaces a stored procedure.\n\nAfter subscription the operation will be performed. The <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> upon successful completion will contain a single resource response with the replaced stored procedure. In case of failure the <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> will error."
|
|
returns:
|
|
description: "an <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the single resource response with the replaced stored procedure or an error."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureResponse?alt=com.azure.cosmos.models.CosmosStoredProcedureResponse&text=CosmosStoredProcedureResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "The type Cosmos async stored procedure."
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|