Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup

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 Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Backup

Returns a new instance of GoogleFirestoreAdminV1Backup.



1203
1204
1205
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1203

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

Instance Attribute Details

#database ⇒ String

Output only. Name of the Firestore database that the backup is from. Format is projects/project/databases/database`. Corresponds to the JSON propertydatabase`

Returns:

  • (String) 


1168
1169
1170
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1168

def database
  @database
end

#database_uid ⇒ String

Output only. The system-generated UUID4 for the Firestore database that the backup is from. Corresponds to the JSON property databaseUid

Returns:

  • (String) 


1174
1175
1176
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1174

def database_uid
  @database_uid
end

#expire_time ⇒ String

Output only. The timestamp at which this backup expires. Corresponds to the JSON property expireTime

Returns:

  • (String) 


1179
1180
1181
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1179

def expire_time
  @expire_time
end

#name ⇒ String

Output only. The unique resource name of the Backup. Format is projects/ project/locations/location/backups/backup`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1185
1186
1187
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1185

def name
  @name
end

#snapshot_time ⇒ String

Output only. The backup contains an externally consistent copy of the database at this time. Corresponds to the JSON property snapshotTime

Returns:

  • (String) 


1191
1192
1193
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1191

def snapshot_time
  @snapshot_time
end

#state ⇒ String

Output only. The current state of the backup. Corresponds to the JSON property state

Returns:

  • (String) 


1196
1197
1198
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1196

def state
  @state
end

#stats ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Stats

Backup specific statistics. Corresponds to the JSON property stats

Returns:



1201
1202
1203
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1201

def stats
  @stats
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1208

def update!(**args)
  @database = args[:database] if args.key?(:database)
  @database_uid = args[:database_uid] if args.key?(:database_uid)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @name = args[:name] if args.key?(:name)
  @snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
  @state = args[:state] if args.key?(:state)
  @stats = args[:stats] if args.key?(:stats)
end