Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A Cloud Firestore Database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Database

Returns a new instance of GoogleFirestoreAdminV1Database.



1753
1754
1755
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1753

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_integration_mode ⇒ String

The App Engine integration mode to use for this database. Corresponds to the JSON property appEngineIntegrationMode

Returns:

  • (String) 


1596
1597
1598
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1596

def app_engine_integration_mode
  @app_engine_integration_mode
end

#cmek_config ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Corresponds to the JSON property cmekConfig

Returns:



1603
1604
1605
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1603

def cmek_config
  @cmek_config
end

#concurrency_mode ⇒ String

The concurrency control mode to use for this database. Corresponds to the JSON property concurrencyMode

Returns:

  • (String) 


1608
1609
1610
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1608

def concurrency_mode
  @concurrency_mode
end

#create_time ⇒ String

Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. Corresponds to the JSON property createTime

Returns:

  • (String) 


1614
1615
1616
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1614

def create_time
  @create_time
end

#database_edition ⇒ String

Immutable. The edition of the database. Corresponds to the JSON property databaseEdition

Returns:

  • (String) 


1619
1620
1621
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1619

def database_edition
  @database_edition
end

#delete_protection_state ⇒ String

State of delete protection for the database. Corresponds to the JSON property deleteProtectionState

Returns:

  • (String) 


1624
1625
1626
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1624

def delete_protection_state
  @delete_protection_state
end

#delete_time ⇒ String

Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1630
1631
1632
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1630

def delete_time
  @delete_time
end

#earliest_version_time ⇒ String

Output only. 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. Corresponds to the JSON property earliestVersionTime

Returns:

  • (String) 


1640
1641
1642
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1640

def earliest_version_time
  @earliest_version_time
end

#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. Corresponds to the JSON property etag

Returns:

  • (String) 


1647
1648
1649
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1647

def etag
  @etag
end

#firestore_data_access_mode ⇒ String

Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. Corresponds to the JSON property firestoreDataAccessMode

Returns:

  • (String) 


1654
1655
1656
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1654

def firestore_data_access_mode
  @firestore_data_access_mode
end

#free_tier ⇒ Boolean Also known as: free_tier?

Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. Corresponds to the JSON property freeTier

Returns:

  • (Boolean) 


1666
1667
1668
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1666

def free_tier
  @free_tier
end

#key_prefix ⇒ String

Output only. 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). Corresponds to the JSON property keyPrefix

Returns:

  • (String) 


1676
1677
1678
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1676

def key_prefix
  @key_prefix
end

#location_id ⇒ String

The location of the database. Available locations are listed at https://cloud. google.com/firestore/docs/locations. Corresponds to the JSON property locationId

Returns:

  • (String) 


1682
1683
1684
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1682

def location_id
  @location_id
end

#mongodb_compatible_data_access_mode ⇒ String

Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. Corresponds to the JSON property mongodbCompatibleDataAccessMode

Returns:

  • (String) 


1690
1691
1692
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1690

def mongodb_compatible_data_access_mode
  @mongodb_compatible_data_access_mode
end

#name ⇒ String

The resource name of the Database. Format: projects/project/databases/ database` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1696
1697
1698
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1696

def name
  @name
end

#point_in_time_recovery_enablement ⇒ String

Whether to enable the PITR feature on this database. Corresponds to the JSON property pointInTimeRecoveryEnablement

Returns:

  • (String) 


1701
1702
1703
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1701

def point_in_time_recovery_enablement
  @point_in_time_recovery_enablement
end

#previous_id ⇒ String

Output only. The database resource's prior database ID. This field is only populated for deleted databases. Corresponds to the JSON property previousId

Returns:

  • (String) 


1707
1708
1709
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1707

def previous_id
  @previous_id
end

#realtime_updates_mode ⇒ String

Immutable. The default Realtime Updates mode to use for this database. Corresponds to the JSON property realtimeUpdatesMode

Returns:

  • (String) 


1712
1713
1714
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1712

def realtime_updates_mode
  @realtime_updates_mode
end

#source_info ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo

Information about the provenance of this database. Corresponds to the JSON property sourceInfo

Returns:



1717
1718
1719
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1717

def source_info
  @source_info
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


1724
1725
1726
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1724

def tags
  @tags
end

#type ⇒ String

The type of the database. See https://cloud.google.com/datastore/docs/ firestore-or-datastore for information about how to choose. Corresponds to the JSON property type

Returns:

  • (String) 


1730
1731
1732
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1730

def type
  @type
end

#uid ⇒ String

Output only. The system-generated UUID4 for this Database. Corresponds to the JSON property uid

Returns:

  • (String) 


1735
1736
1737
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1735

def uid
  @uid
end

#update_time ⇒ String

Output only. 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. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1742
1743
1744
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1742

def update_time
  @update_time
end

#version_retention_period ⇒ String

Output only. 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. Corresponds to the JSON property versionRetentionPeriod

Returns:

  • (String) 


1751
1752
1753
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1751

def version_retention_period
  @version_retention_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1758

def update!(**args)
  @app_engine_integration_mode = args[:app_engine_integration_mode] if args.key?(:app_engine_integration_mode)
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
  @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database_edition = args[:database_edition] if args.key?(:database_edition)
  @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @earliest_version_time = args[:earliest_version_time] if args.key?(:earliest_version_time)
  @etag = args[:etag] if args.key?(:etag)
  @firestore_data_access_mode = args[:firestore_data_access_mode] if args.key?(:firestore_data_access_mode)
  @free_tier = args[:free_tier] if args.key?(:free_tier)
  @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
  @location_id = args[:location_id] if args.key?(:location_id)
  @mongodb_compatible_data_access_mode = args[:mongodb_compatible_data_access_mode] if args.key?(:mongodb_compatible_data_access_mode)
  @name = args[:name] if args.key?(:name)
  @point_in_time_recovery_enablement = args[:point_in_time_recovery_enablement] if args.key?(:point_in_time_recovery_enablement)
  @previous_id = args[:previous_id] if args.key?(:previous_id)
  @realtime_updates_mode = args[:realtime_updates_mode] if args.key?(:realtime_updates_mode)
  @source_info = args[:source_info] if args.key?(:source_info)
  @tags = args[:tags] if args.key?(:tags)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_retention_period = args[:version_retention_period] if args.key?(:version_retention_period)
end