### YamlMime:JavaType uid: "com.azure.cosmos.CosmosAsyncClient" fullName: "com.azure.cosmos.CosmosAsyncClient" name: "CosmosAsyncClient" nameWithType: "CosmosAsyncClient" summary: "Provides a client-side logical representation of the Azure Cosmos DB service." inheritances: - "" inheritedClassMethods: - classRef: "java.lang.Object" methodsRef: - "clone" - "equals" - "finalize" - "getClass" - "hashCode" - "notify" - "notifyAll" - "toString" - "wait" - "wait" - "wait" syntax: "public final class **CosmosAsyncClient**
implements Closeable" methods: - uid: "com.azure.cosmos.CosmosAsyncClient.close()" fullName: "com.azure.cosmos.CosmosAsyncClient.close()" name: "close()" nameWithType: "CosmosAsyncClient.close()" summary: "Close this instance and cleans up the resources." syntax: "public void close()" desc: "Close this instance and cleans up the resources." - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(com.azure.cosmos.models.CosmosDatabaseProperties)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties)" name: "createDatabase(CosmosDatabaseProperties databaseProperties)" nameWithType: "CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties)" summary: "Creates a database." parameters: - description: "." name: "databaseProperties" type: "" syntax: "public Mono createDatabase(CosmosDatabaseProperties databaseProperties)" desc: "Creates a database.\nAfter subscription the operation will be performed. The upon successful completion will contain a single resource response with the created database. In case of failure the will error." returns: description: "an containing the single cosmos database response with the created database or an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(com.azure.cosmos.models.CosmosDatabaseProperties,com.azure.cosmos.models.CosmosDatabaseRequestOptions)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)" name: "createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)" nameWithType: "CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)" summary: "Creates a database." parameters: - description: "." name: "databaseProperties" type: "" - description: "." name: "options" type: "" syntax: "public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)" desc: "Creates a database.\nAfter subscription the operation will be performed. The upon successful completion will contain a single resource response with the created database. In case of failure the will error." returns: description: "an containing the single cosmos database response with the created database or an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(com.azure.cosmos.models.CosmosDatabaseProperties,com.azure.cosmos.models.ThroughputProperties)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)" name: "createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)" nameWithType: "CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)" summary: "Creates a database." parameters: - description: "." name: "databaseProperties" type: "" - description: "the throughput properties for the database." name: "throughputProperties" type: "" syntax: "public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)" desc: "Creates a database.\nAfter subscription the operation will be performed. The upon successful completion will contain a single resource response with the created database. In case of failure the will error." returns: description: "an containing the single cosmos database response with the created database or an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(com.azure.cosmos.models.CosmosDatabaseProperties,com.azure.cosmos.models.ThroughputProperties,com.azure.cosmos.models.CosmosDatabaseRequestOptions)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)" name: "createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)" nameWithType: "CosmosAsyncClient.createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)" summary: "Creates a database." parameters: - description: "." name: "databaseProperties" type: "" - description: "the throughput properties for the database." name: "throughputProperties" type: "" - description: "." name: "options" type: "" syntax: "public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)" desc: "Creates a database.\nAfter subscription the operation will be performed. The upon successful completion will contain a single resource response with the created database. In case of failure the will error." returns: description: "an containing the single cosmos database response with the created database or an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(java.lang.String)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(String id)" name: "createDatabase(String id)" nameWithType: "CosmosAsyncClient.createDatabase(String id)" summary: "Creates a database." parameters: - description: "id of the database." name: "id" type: "String" syntax: "public Mono createDatabase(String id)" desc: "Creates a database.\nAfter subscription the operation will be performed. The upon successful completion will contain a single resource response with the created database. In case of failure the will error." returns: description: "a containing the single cosmos database response with the created database or an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabase(java.lang.String,com.azure.cosmos.models.ThroughputProperties)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabase(String id, ThroughputProperties throughputProperties)" name: "createDatabase(String id, ThroughputProperties throughputProperties)" nameWithType: "CosmosAsyncClient.createDatabase(String id, ThroughputProperties throughputProperties)" summary: "Creates a database." parameters: - description: "the id." name: "id" type: "String" - description: "the throughputProperties." name: "throughputProperties" type: "" syntax: "public Mono createDatabase(String id, ThroughputProperties throughputProperties)" desc: "Creates a database." returns: description: "the mono." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(com.azure.cosmos.models.CosmosDatabaseProperties)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)" name: "createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)" nameWithType: "CosmosAsyncClient.createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)" summary: "CREATE a Database if it does not already exist on the service." parameters: - description: "CosmosDatabaseProperties." name: "databaseProperties" type: "" syntax: "public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)" desc: "CREATE a Database if it does not already exist on the service.\nThe upon successful completion will contain a single cosmos database response with the created or existing database." returns: description: "a containing the cosmos database response with the created or existing database or\n an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(java.lang.String)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(String id)" name: "createDatabaseIfNotExists(String id)" nameWithType: "CosmosAsyncClient.createDatabaseIfNotExists(String id)" summary: "Create a Database if it does not already exist on the service." parameters: - description: "the id of the database." name: "id" type: "String" syntax: "public Mono createDatabaseIfNotExists(String id)" desc: "Create a Database if it does not already exist on the service.\nThe upon successful completion will contain a single cosmos database response with the created or existing database." returns: description: "a containing the cosmos database response with the created or existing database or\n an error." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(java.lang.String,com.azure.cosmos.models.ThroughputProperties)" fullName: "com.azure.cosmos.CosmosAsyncClient.createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)" name: "createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)" nameWithType: "CosmosAsyncClient.createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)" summary: "Create a Database if it does not already exist on the service." parameters: - description: "the id." name: "id" type: "String" - description: "the throughputProperties." name: "throughputProperties" type: "" syntax: "public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)" desc: "Create a Database if it does not already exist on the service.\nThe throughputProperties will only be used if the specified database does not exist and therefor a new database will be created with throughputProperties.\nThe upon successful completion will contain a single cosmos database response with the created or existing database." returns: description: "the mono." type: "Mono<>" - uid: "com.azure.cosmos.CosmosAsyncClient.createGlobalThroughputControlConfigBuilder(java.lang.String,java.lang.String)" fullName: "com.azure.cosmos.CosmosAsyncClient.createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)" name: "createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)" nameWithType: "CosmosAsyncClient.createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)" summary: "Create global throughput control config builder which will be used to build ." parameters: - description: "The database id of the control container." name: "databaseId" type: "String" - description: "The container id of the control container." name: "containerId" type: "String" syntax: "public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)" desc: "Create global throughput control config builder which will be used to build ." returns: description: "A ." type: "" - uid: "com.azure.cosmos.CosmosAsyncClient.getDatabase(java.lang.String)" fullName: "com.azure.cosmos.CosmosAsyncClient.getDatabase(String id)" name: "getDatabase(String id)" nameWithType: "CosmosAsyncClient.getDatabase(String id)" summary: "Gets a database object without making a service call." parameters: - description: "name of the database." name: "id" type: "String" syntax: "public CosmosAsyncDatabase getDatabase(String id)" desc: "Gets a database object without making a service call." returns: description: "." type: "" - uid: "com.azure.cosmos.CosmosAsyncClient.queryDatabases(com.azure.cosmos.models.SqlQuerySpec,com.azure.cosmos.models.CosmosQueryRequestOptions)" fullName: "com.azure.cosmos.CosmosAsyncClient.queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)" name: "queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)" nameWithType: "CosmosAsyncClient.queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)" summary: "Query for databases." parameters: - description: "the SQL query specification." name: "querySpec" type: "" - description: "the feed options." name: "options" type: "" syntax: "public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)" desc: "Query for databases.\nAfter subscription the operation will be performed. The will contain one or several feed response of the read databases. In case of failure the will error." returns: description: "a containing one or several feed response pages of read databases or an error." type: "<>" - uid: "com.azure.cosmos.CosmosAsyncClient.queryDatabases(java.lang.String,com.azure.cosmos.models.CosmosQueryRequestOptions)" fullName: "com.azure.cosmos.CosmosAsyncClient.queryDatabases(String query, CosmosQueryRequestOptions options)" name: "queryDatabases(String query, CosmosQueryRequestOptions options)" nameWithType: "CosmosAsyncClient.queryDatabases(String query, CosmosQueryRequestOptions options)" summary: "Query for databases." parameters: - description: "the query." name: "query" type: "String" - description: "the feed options." name: "options" type: "" syntax: "public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)" desc: "Query for databases.\nAfter subscription the operation will be performed. The will contain one or several feed response of the read databases. In case of failure the will error." returns: description: "a containing one or several feed response pages of read databases or an error." type: "<>" - uid: "com.azure.cosmos.CosmosAsyncClient.readAllDatabases()" fullName: "com.azure.cosmos.CosmosAsyncClient.readAllDatabases()" name: "readAllDatabases()" nameWithType: "CosmosAsyncClient.readAllDatabases()" summary: "Reads all databases." syntax: "public CosmosPagedFlux readAllDatabases()" desc: "Reads all databases.\nAfter subscription the operation will be performed. The will contain one or several feed response of the read databases. In case of failure the will error." returns: description: "a containing one or several feed response pages of read databases or an error." type: "<>" type: "class" desc: "Provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service.\n\nCosmosAsyncClient is thread-safe. It's recommended to maintain a single instance of CosmosAsyncClient per lifetime of the application which enables efficient connection management and performance. CosmosAsyncClient initialization is a heavy operation - don't use initialization CosmosAsyncClient instances as credentials or network connectivity validations." implements: - "Closeable" metadata: {} package: "com.azure.cosmos" artifact: com.azure:azure-cosmos:4.63.4