187 строки
17 KiB
YAML
187 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.DatabaseAccount"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount"
|
|
name: "DatabaseAccount"
|
|
nameWithType: "DatabaseAccount"
|
|
summary: "Represents a database account in the Azure Cosmos DB database service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getETag()?alt=com.microsoft.azure.documentdb.Resource.getETag&text=getETag\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getId()?alt=com.microsoft.azure.documentdb.Resource.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getResourceId()?alt=com.microsoft.azure.documentdb.Resource.getResourceId&text=getResourceId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getSelfLink()?alt=com.microsoft.azure.documentdb.Resource.getSelfLink&text=getSelfLink\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getTimestamp()?alt=com.microsoft.azure.documentdb.Resource.getTimestamp&text=getTimestamp\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setId&text=setId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setResourceId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setResourceId&text=setResourceId\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **DatabaseAccount**</br> extends <xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.DatabaseAccount(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.DatabaseAccount(String jsonString)"
|
|
name: "DatabaseAccount(String jsonString)"
|
|
nameWithType: "DatabaseAccount.DatabaseAccount(String jsonString)"
|
|
summary: "Initialize a database account object from json string."
|
|
parameters:
|
|
- description: "the json string that represents the database account."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccount(String jsonString)"
|
|
desc: "Initialize a database account object from json string."
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.DatabaseAccount(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.DatabaseAccount(JSONObject jsonObject)"
|
|
name: "DatabaseAccount(JSONObject jsonObject)"
|
|
nameWithType: "DatabaseAccount.DatabaseAccount(JSONObject jsonObject)"
|
|
summary: "Initialize a database account object from json object."
|
|
parameters:
|
|
- description: "the json object that represents the database account."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccount(JSONObject jsonObject)"
|
|
desc: "Initialize a database account object from json object."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getAddressesLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getAddressesLink()"
|
|
name: "getAddressesLink()"
|
|
nameWithType: "DatabaseAccount.getAddressesLink()"
|
|
summary: "Get the addresseslink of the database<wbr>Account."
|
|
syntax: "public String getAddressesLink()"
|
|
desc: "Get the addresseslink of the databaseAccount."
|
|
returns:
|
|
description: "the addresses link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getConsistencyPolicy()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getConsistencyPolicy()"
|
|
name: "getConsistencyPolicy()"
|
|
nameWithType: "DatabaseAccount.getConsistencyPolicy()"
|
|
summary: "Gets the Consistency<wbr>Policy settings."
|
|
syntax: "public ConsistencyPolicy getConsistencyPolicy()"
|
|
desc: "Gets the ConsistencyPolicy settings."
|
|
returns:
|
|
description: "the consistency policy."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ConsistencyPolicy?alt=com.microsoft.azure.documentdb.ConsistencyPolicy&text=ConsistencyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getDatabasesLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getDatabasesLink()"
|
|
name: "getDatabasesLink()"
|
|
nameWithType: "DatabaseAccount.getDatabasesLink()"
|
|
summary: "Get the databases link of the database<wbr>Account."
|
|
syntax: "public String getDatabasesLink()"
|
|
desc: "Get the databases link of the databaseAccount."
|
|
returns:
|
|
description: "the databases link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getEnableMultipleWritableLocations()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getEnableMultipleWritableLocations()"
|
|
name: "getEnableMultipleWritableLocations()"
|
|
nameWithType: "DatabaseAccount.getEnableMultipleWritableLocations()"
|
|
summary: "Gets the enable<wbr>Muliple<wbr>Writable<wbr>Locations flag of the database<wbr>Account."
|
|
syntax: "public boolean getEnableMultipleWritableLocations()"
|
|
desc: "Gets the enableMulipleWritableLocations flag of the databaseAccount."
|
|
returns:
|
|
description: "the enableMulipleWritableLocations flag value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getMaxMediaStorageUsageInMB()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getMaxMediaStorageUsageInMB()"
|
|
name: "getMaxMediaStorageUsageInMB()"
|
|
nameWithType: "DatabaseAccount.getMaxMediaStorageUsageInMB()"
|
|
summary: "Attachment content (media) storage quota in MBs Retrieved from gateway."
|
|
syntax: "public long getMaxMediaStorageUsageInMB()"
|
|
desc: "Attachment content (media) storage quota in MBs Retrieved from gateway."
|
|
returns:
|
|
description: "the max media storage usage in MB."
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getMediaLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getMediaLink()"
|
|
name: "getMediaLink()"
|
|
nameWithType: "DatabaseAccount.getMediaLink()"
|
|
summary: "Get the medialink of the database<wbr>Account."
|
|
syntax: "public String getMediaLink()"
|
|
desc: "Get the medialink of the databaseAccount."
|
|
returns:
|
|
description: "the media link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getMediaStorageUsageInMB()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getMediaStorageUsageInMB()"
|
|
name: "getMediaStorageUsageInMB()"
|
|
nameWithType: "DatabaseAccount.getMediaStorageUsageInMB()"
|
|
summary: "Current attachment content (media) usage in MBs."
|
|
syntax: "public long getMediaStorageUsageInMB()"
|
|
desc: "Current attachment content (media) usage in MBs.\n\nRetrieved from gateway. Value is returned from cached information updated periodically and is not guaranteed to be real time."
|
|
returns:
|
|
description: "the media storage usage in MB."
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getReadableLocations()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getReadableLocations()"
|
|
name: "getReadableLocations()"
|
|
nameWithType: "DatabaseAccount.getReadableLocations()"
|
|
summary: "Gets the list of readable locations for this database account."
|
|
syntax: "public Iterable<DatabaseAccountLocation> getReadableLocations()"
|
|
desc: "Gets the list of readable locations for this database account."
|
|
returns:
|
|
description: "the list of readable locations."
|
|
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DatabaseAccountLocation?alt=com.microsoft.azure.documentdb.DatabaseAccountLocation&text=DatabaseAccountLocation\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getReplicationPolicy()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getReplicationPolicy()"
|
|
name: "getReplicationPolicy()"
|
|
nameWithType: "DatabaseAccount.getReplicationPolicy()"
|
|
summary: "Gets the Replication<wbr>Policy settings."
|
|
syntax: "public ReplicationPolicy getReplicationPolicy()"
|
|
desc: "Gets the ReplicationPolicy settings."
|
|
returns:
|
|
description: "the replication policy."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ReplicationPolicy?alt=com.microsoft.azure.documentdb.ReplicationPolicy&text=ReplicationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DatabaseAccount.getWritableLocations()"
|
|
fullName: "com.microsoft.azure.documentdb.DatabaseAccount.getWritableLocations()"
|
|
name: "getWritableLocations()"
|
|
nameWithType: "DatabaseAccount.getWritableLocations()"
|
|
summary: "Gets the list of writable locations for this database account."
|
|
syntax: "public Iterable<DatabaseAccountLocation> getWritableLocations()"
|
|
desc: "Gets the list of writable locations for this database account."
|
|
returns:
|
|
description: "the list of writable locations."
|
|
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.DatabaseAccountLocation?alt=com.microsoft.azure.documentdb.DatabaseAccountLocation&text=DatabaseAccountLocation\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Represents a database account in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|