-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.CosmosAsyncUserDefinedFunction.yml
73 lines (73 loc) · 7.37 KB
/
com.azure.cosmos.CosmosAsyncUserDefinedFunction.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
### YamlMime:JavaType
uid: "com.azure.cosmos.CosmosAsyncUserDefinedFunction"
fullName: "com.azure.cosmos.CosmosAsyncUserDefinedFunction"
name: "CosmosAsyncUserDefinedFunction"
nameWithType: "CosmosAsyncUserDefinedFunction"
summary: "The type Cosmos async user defined function."
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 **CosmosAsyncUserDefinedFunction**"
methods:
- uid: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.delete()"
fullName: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.delete()"
name: "delete()"
nameWithType: "CosmosAsyncUserDefinedFunction.delete()"
summary: "Deletes a cosmos user defined function."
syntax: "public Mono<CosmosUserDefinedFunctionResponse> delete()"
desc: "Deletes a cosmos user defined function.\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 user defined function. 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 cosmos user defined function or\n 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.CosmosUserDefinedFunctionResponse?alt=com.azure.cosmos.models.CosmosUserDefinedFunctionResponse&text=CosmosUserDefinedFunctionResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.getId()"
fullName: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.getId()"
name: "getId()"
nameWithType: "CosmosAsyncUserDefinedFunction.getId()"
summary: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncUserDefinedFunction\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncUserDefinedFunction\"></xref>"
syntax: "public String getId()"
desc: "Get the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncUserDefinedFunction\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncUserDefinedFunction\"></xref>"
returns:
description: "the id of the <xref uid=\"com.azure.cosmos.CosmosAsyncUserDefinedFunction\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncUserDefinedFunction\"></xref>"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.read()"
fullName: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.read()"
name: "read()"
nameWithType: "CosmosAsyncUserDefinedFunction.read()"
summary: "Read a user defined function."
syntax: "public Mono<CosmosUserDefinedFunctionResponse> read()"
desc: "Read a user defined function.\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 read user defined function. 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 read user defined function 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.CosmosUserDefinedFunctionResponse?alt=com.azure.cosmos.models.CosmosUserDefinedFunctionResponse&text=CosmosUserDefinedFunctionResponse\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.replace(com.azure.cosmos.models.CosmosUserDefinedFunctionProperties)"
fullName: "com.azure.cosmos.CosmosAsyncUserDefinedFunction.replace(CosmosUserDefinedFunctionProperties udfSettings)"
name: "replace(CosmosUserDefinedFunctionProperties udfSettings)"
nameWithType: "CosmosAsyncUserDefinedFunction.replace(CosmosUserDefinedFunctionProperties udfSettings)"
summary: "Replaces a cosmos user defined function."
parameters:
- description: "the cosmos user defined function properties."
name: "udfSettings"
type: "<xref href=\"com.azure.cosmos.models.CosmosUserDefinedFunctionProperties?alt=com.azure.cosmos.models.CosmosUserDefinedFunctionProperties&text=CosmosUserDefinedFunctionProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<CosmosUserDefinedFunctionResponse> replace(CosmosUserDefinedFunctionProperties udfSettings)"
desc: "Replaces a cosmos user defined function.\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 user defined function. 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 cosmos user defined function\n 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.CosmosUserDefinedFunctionResponse?alt=com.azure.cosmos.models.CosmosUserDefinedFunctionResponse&text=CosmosUserDefinedFunctionResponse\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "The type Cosmos async user defined function."
metadata: {}
package: "com.azure.cosmos"
artifact: com.azure:azure-cosmos:4.62.0