google-native.firestore/v1.getDatabase

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

Using getDatabase

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>

def get_database(database_id: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(database_id: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]

func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

> Note: This function is named LookupDatabase in the Go SDK.

public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:firestore/v1:getDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseId string
Project string

DatabaseId string
Project string

databaseId String
project String

databaseId string
project string

database_id str
project str

databaseId String
project String

getDatabase Result

The following output properties are available:

AppEngineIntegrationMode string: The App Engine integration mode to use for this database.
ConcurrencyMode string: The concurrency control mode to use for this database.
CreateTime string: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
DeleteProtectionState string: State of delete protection for the database.
EarliestVersionTime string: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
Etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
KeyPrefix string: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
Location string: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
Name string: The resource name of the Database. Format: projects/{project}/databases/{database}
PointInTimeRecoveryEnablement string: Whether to enable the PITR feature on this database.
Type string: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
Uid string: The system-generated UUID4 for this Database.
UpdateTime string: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
VersionRetentionPeriod string: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

AppEngineIntegrationMode string: The App Engine integration mode to use for this database.
ConcurrencyMode string: The concurrency control mode to use for this database.
CreateTime string: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
DeleteProtectionState string: State of delete protection for the database.
EarliestVersionTime string: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
Etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
KeyPrefix string: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
Location string: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
Name string: The resource name of the Database. Format: projects/{project}/databases/{database}
PointInTimeRecoveryEnablement string: Whether to enable the PITR feature on this database.
Type string: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
Uid string: The system-generated UUID4 for this Database.
UpdateTime string: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
VersionRetentionPeriod string: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

appEngineIntegrationMode String: The App Engine integration mode to use for this database.
concurrencyMode String: The concurrency control mode to use for this database.
createTime String: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
deleteProtectionState String: State of delete protection for the database.
earliestVersionTime String: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
etag String: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
keyPrefix String: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
location String: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
name String: The resource name of the Database. Format: projects/{project}/databases/{database}
pointInTimeRecoveryEnablement String: Whether to enable the PITR feature on this database.
type String: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
uid String: The system-generated UUID4 for this Database.
updateTime String: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
versionRetentionPeriod String: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

appEngineIntegrationMode string: The App Engine integration mode to use for this database.
concurrencyMode string: The concurrency control mode to use for this database.
createTime string: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
deleteProtectionState string: State of delete protection for the database.
earliestVersionTime string: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
keyPrefix string: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
location string: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
name string: The resource name of the Database. Format: projects/{project}/databases/{database}
pointInTimeRecoveryEnablement string: Whether to enable the PITR feature on this database.
type string: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
uid string: The system-generated UUID4 for this Database.
updateTime string: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
versionRetentionPeriod string: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

app_engine_integration_mode str: The App Engine integration mode to use for this database.
concurrency_mode str: The concurrency control mode to use for this database.
create_time str: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
delete_protection_state str: State of delete protection for the database.
earliest_version_time str: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
etag str: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
key_prefix str: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
location str: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
name str: The resource name of the Database. Format: projects/{project}/databases/{database}
point_in_time_recovery_enablement str: Whether to enable the PITR feature on this database.
type str: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
uid str: The system-generated UUID4 for this Database.
update_time str: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
version_retention_period str: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

appEngineIntegrationMode String: The App Engine integration mode to use for this database.
concurrencyMode String: The concurrency control mode to use for this database.
createTime String: The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
deleteProtectionState String: State of delete protection for the database.
earliestVersionTime String: The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
etag String: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
keyPrefix String: The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
location String: The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
name String: The resource name of the Database. Format: projects/{project}/databases/{database}
pointInTimeRecoveryEnablement String: Whether to enable the PITR feature on this database.
type String: The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
uid String: The system-generated UUID4 for this Database.
updateTime String: The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
versionRetentionPeriod String: The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.firestore/v1.getDatabase

On this page

On this page

Using getDatabase

getDatabase Result

Package Details

On this page

On this page