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. Currently only one database is allowed per cloud project; this database must have a database_id of '(default)'.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Database

Returns a new instance of GoogleFirestoreAdminV1Database.



929
930
931
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 929

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) 


866
867
868
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 866

def app_engine_integration_mode
  @app_engine_integration_mode
end

#concurrency_mode ⇒ String

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

Returns:

  • (String) 


871
872
873
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 871

def concurrency_mode
  @concurrency_mode
end

#create_time ⇒ String

Output only. The timestamp at which this database was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


876
877
878
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 876

def create_time
  @create_time
end

#delete_protection_state ⇒ String

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

Returns:

  • (String) 


881
882
883
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 881

def delete_protection_state
  @delete_protection_state
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) 


888
889
890
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 888

def etag
  @etag
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) 


897
898
899
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 897

def key_prefix
  @key_prefix
end

#location_id ⇒ String

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

Returns:

  • (String) 


903
904
905
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 903

def location_id
  @location_id
end

#name ⇒ String

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

Returns:

  • (String) 


909
910
911
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 909

def name
  @name
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) 


915
916
917
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 915

def type
  @type
end

#uid ⇒ String

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

Returns:

  • (String) 


920
921
922
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 920

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) 


927
928
929
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 927

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 934

def update!(**args)
  @app_engine_integration_mode = args[:app_engine_integration_mode] if args.key?(:app_engine_integration_mode)
  @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
  @etag = args[:etag] if args.key?(:etag)
  @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
  @location_id = args[:location_id] if args.key?(:location_id)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end