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.



827
828
829
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 827

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) 


786
787
788
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 786

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) 


791
792
793
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 791

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


798
799
800
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 798

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) 


807
808
809
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 807

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) 


813
814
815
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 813

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) 


819
820
821
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 819

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) 


825
826
827
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 825

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



832
833
834
835
836
837
838
839
840
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 832

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)
  @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)
end