CosmosDatabaseProperties Class

  • Reference
Package:
com.azure.cosmos.models
Maven Artifact:
com.azure:azure-cosmos:4.59.0
  • java.lang.Object
    • com.azure.cosmos.models.CosmosDatabaseProperties

public final class CosmosDatabaseProperties

Represents a CosmosAsyncDatabase in the Azure Cosmos database service. A cosmos database manages users, permissions and a set of containers

Each 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.

Constructor Summary

Constructor Description
CosmosDatabaseProperties(String id)

Constructor

Method Summary

Modifier and Type Method and Description
String getETag()

Get the entity tag associated with the resource.
String getId()

Gets the name of the resource.
String getResourceId()

Gets the ID associated with the resource.
Instant getTimestamp()

Get the last modified timestamp associated with the resource.
CosmosDatabaseProperties setId(String id)

Sets the name of the resource.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CosmosDatabaseProperties

public CosmosDatabaseProperties(String id)

Constructor

Parameters:

id - id of the database

Method Details

getETag

public String getETag()

Get the entity tag associated with the resource. This is only relevant when getting response from the server.

Returns:

the e tag.

getId

public String getId()

Gets the name of the resource.

Returns:

the name of the resource.

getResourceId

public String getResourceId()

Gets the ID associated with the resource.

Returns:

the ID associated with the resource.

getTimestamp

public Instant getTimestamp()

Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server.

Returns:

the timestamp.

setId

public CosmosDatabaseProperties setId(String id)

Sets the name of the resource.

Parameters:

id - the name of the resource.

Returns:

the current instance of CosmosDatabaseProperties.

Applies to