-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.cosmos.models.ComputedProperty.yml
64 lines (64 loc) · 5.03 KB
/
com.azure.cosmos.models.ComputedProperty.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
### YamlMime:JavaType
uid: "com.azure.cosmos.models.ComputedProperty"
fullName: "com.azure.cosmos.models.ComputedProperty"
name: "ComputedProperty"
nameWithType: "ComputedProperty"
summary: "Represents a computed property definition for a Cosmos DB container."
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 final class **ComputedProperty**"
constructors:
- uid: "com.azure.cosmos.models.ComputedProperty.ComputedProperty(java.lang.String,java.lang.String)"
fullName: "com.azure.cosmos.models.ComputedProperty.ComputedProperty(String name, String query)"
name: "ComputedProperty(String name, String query)"
nameWithType: "ComputedProperty.ComputedProperty(String name, String query)"
summary: "Instantiates a new Computed properties with name and query."
parameters:
- description: "the name of the computed property."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the query used to evaluate the value for the computed property."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ComputedProperty(String name, String query)"
desc: "Instantiates a new Computed properties with name and query."
methods:
- uid: "com.azure.cosmos.models.ComputedProperty.getName()"
fullName: "com.azure.cosmos.models.ComputedProperty.getName()"
name: "getName()"
nameWithType: "ComputedProperty.getName()"
summary: "Gets the name of the computed property."
syntax: "public String getName()"
desc: "Gets the name of the computed property."
returns:
description: "the name of the computed property."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.ComputedProperty.getQuery()"
fullName: "com.azure.cosmos.models.ComputedProperty.getQuery()"
name: "getQuery()"
nameWithType: "ComputedProperty.getQuery()"
summary: "Gets the query used to evaluate the value for the computed property."
syntax: "public String getQuery()"
desc: "Gets the query used to evaluate the value for the computed property."
returns:
description: "the query for the computed property."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Represents a computed property definition for a Cosmos DB container. Below is an example of how to use <xref uid=\"com.azure.cosmos.models.ComputedProperty\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputedProperty\"></xref> in the context of creating a container.\n\n```java\nList<ComputedProperty> computedProperties = new ArrayList<>(\n Arrays.asList(\n new ComputedProperty(\"lowerName\", \"SELECT VALUE LOWER(c.name) FROM c\")\n )\n );\n containerProperties.setComputedProperties(computedProperties);\n database.createContainer(containerProperties).subscribe();\n```\n\nBelow is an example of how to use <xref uid=\"com.azure.cosmos.models.ComputedProperty\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputedProperty\"></xref> in the context of replacing a container.\n\n```java\nCosmosContainerProperties containerProperties = getCollectionDefinition(containerName);\n List<ComputedProperty> computedProperties = new ArrayList<>(\n Arrays.asList(\n new ComputedProperty(\"upperName\", \"SELECT VALUE UPPER(c.name) FROM c\")\n )\n );\n containerProperties.setComputedProperties(computedProperties);\n container = database.getContainer(containerName);\n container.replace(containerProperties).subscribe();\n```"
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.61.1