Class: Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexOperationMetadata

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

Overview

Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta2IndexOperationMetadata

Returns a new instance of GoogleFirestoreAdminV1beta2IndexOperationMetadata



574
575
576
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 574

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

Instance Attribute Details

#end_timeString

The time this operation completed. Will be unset if operation still in progress. Corresponds to the JSON property endTime

Returns:

  • (String)


541
542
543
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 541

def end_time
  @end_time
end

#indexString

The index resource that this operation is acting on. For example: projects/project_id/databases/database_id/collectionGroups/collection_id /indexes/index_id` Corresponds to the JSON propertyindex`

Returns:

  • (String)


548
549
550
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 548

def index
  @index
end

#progress_bytesGoogle::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress

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 progressBytes



555
556
557
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 555

def progress_bytes
  @progress_bytes
end

#progress_documentsGoogle::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress

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 progressDocuments



562
563
564
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 562

def progress_documents
  @progress_documents
end

#start_timeString

The time this operation started. Corresponds to the JSON property startTime

Returns:

  • (String)


567
568
569
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 567

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


572
573
574
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 572

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



579
580
581
582
583
584
585
586
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 579

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @index = args[:index] if args.key?(:index)
  @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes)
  @progress_documents = args[:progress_documents] if args.key?(:progress_documents)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
end