Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CloneDatabaseMetadata

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

Metadata for the long-running operation from the CloneDatabase request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1CloneDatabaseMetadata

Returns a new instance of GoogleFirestoreAdminV1CloneDatabaseMetadata.



1704
1705
1706
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1704

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

Instance Attribute Details

#database ⇒ String

The name of the database being cloned to. Corresponds to the JSON property database

Returns:

  • (String) 


1672
1673
1674
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1672

def database
  @database
end

#end_time ⇒ String

The time the clone finished, unset for ongoing clones. Corresponds to the JSON property endTime

Returns:

  • (String) 


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

def end_time
  @end_time
end

#operation_state ⇒ String

The operation state of the clone. Corresponds to the JSON property operationState

Returns:

  • (String) 


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

def operation_state
  @operation_state
end

#pitr_snapshot ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1PitrSnapshot

A consistent snapshot of a database at a specific point in time. A PITR (Point- in-time recovery) snapshot with previous versions of a database's data is available for every minute up to the associated database's data retention period. If the PITR feature is enabled, the retention period is 7 days; otherwise, it is one hour. Corresponds to the JSON property pitrSnapshot

Returns:



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

def pitr_snapshot
  @pitr_snapshot
end

#progress_percentage ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. Corresponds to the JSON property progressPercentage

Returns:



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

def progress_percentage
  @progress_percentage
end

#start_time ⇒ String

The time the clone was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


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

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1709

def update!(**args)
  @database = args[:database] if args.key?(:database)
  @end_time = args[:end_time] if args.key?(:end_time)
  @operation_state = args[:operation_state] if args.key?(:operation_state)
  @pitr_snapshot = args[:pitr_snapshot] if args.key?(:pitr_snapshot)
  @progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
  @start_time = args[:start_time] if args.key?(:start_time)
end