-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.CosmosDatabaseProperties.yml
95 lines (95 loc) · 6.13 KB
/
com.azure.cosmos.models.CosmosDatabaseProperties.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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosDatabaseProperties"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties"
name: "CosmosDatabaseProperties"
nameWithType: "CosmosDatabaseProperties"
summary: "Represents a Cosmos<wbr>Async<wbr>Database in the Azure Cosmos database service."
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 **CosmosDatabaseProperties**"
constructors:
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.CosmosDatabaseProperties(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.CosmosDatabaseProperties(String id)"
name: "CosmosDatabaseProperties(String id)"
nameWithType: "CosmosDatabaseProperties.CosmosDatabaseProperties(String id)"
summary: "Constructor"
parameters:
- description: "id of the database"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosDatabaseProperties(String id)"
desc: "Constructor"
methods:
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.getETag()"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.getETag()"
name: "getETag()"
nameWithType: "CosmosDatabaseProperties.getETag()"
summary: "Get the entity tag associated with the resource."
syntax: "public String getETag()"
desc: "Get the entity tag associated with the resource. This is only relevant when getting response from the server."
returns:
description: "the e tag."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.getId()"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.getId()"
name: "getId()"
nameWithType: "CosmosDatabaseProperties.getId()"
summary: "Gets the name of the resource."
syntax: "public String getId()"
desc: "Gets the name of the resource."
returns:
description: "the name of the resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.getResourceId()"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.getResourceId()"
name: "getResourceId()"
nameWithType: "CosmosDatabaseProperties.getResourceId()"
summary: "Gets the ID associated with the resource."
syntax: "public String getResourceId()"
desc: "Gets the ID associated with the resource."
returns:
description: "the ID associated with the resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.getTimestamp()"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.getTimestamp()"
name: "getTimestamp()"
nameWithType: "CosmosDatabaseProperties.getTimestamp()"
summary: "Get the last modified timestamp associated with the resource."
syntax: "public Instant getTimestamp()"
desc: "Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server."
returns:
description: "the timestamp."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
- uid: "com.azure.cosmos.models.CosmosDatabaseProperties.setId(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosDatabaseProperties.setId(String id)"
name: "setId(String id)"
nameWithType: "CosmosDatabaseProperties.setId(String id)"
summary: "Sets the name of the resource."
parameters:
- description: "the name of the resource."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CosmosDatabaseProperties setId(String id)"
desc: "Sets the name of the resource."
returns:
description: "the current instance of <xref uid=\"com.azure.cosmos.models.CosmosDatabaseProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDatabaseProperties\"></xref>."
type: "<xref href=\"com.azure.cosmos.models.CosmosDatabaseProperties?alt=com.azure.cosmos.models.CosmosDatabaseProperties&text=CosmosDatabaseProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a CosmosAsyncDatabase in the Azure Cosmos database service. A cosmos database manages users, permissions and a set of containers\n\nEach Azure Cosmos DB Service is able to support multiple independent named databases, with the database being the logical container for data. Each Database consists of one or more cosmos containers, each of which in turn contain one or more cosmos items. Since databases are an an administrative resource and the Service Key will be required in order to access and successfully complete any action using the User APIs."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0