Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1FieldOperationMetadata

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

Overview

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

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) ⇒ GoogleFirestoreAdminV1FieldOperationMetadata

Returns a new instance of GoogleFirestoreAdminV1FieldOperationMetadata



256
257
258
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 256

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

Instance Attribute Details

#end_time ⇒ String

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

Returns:

  • (String) 


217
218
219
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 217

def end_time
  @end_time
end

#field ⇒ String

The field resource that this operation is acting on. For example: projects/project_id/databases/database_id/collectionGroups/collection_id /fields/field_path` Corresponds to the JSON propertyfield`

Returns:

  • (String) 


224
225
226
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 224

def field
  @field
end

#index_config_deltas ⇒ Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfigDelta>

A list of IndexConfigDelta, which describe the intent of this operation. Corresponds to the JSON property indexConfigDeltas

Returns:



230
231
232
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 230

def index_config_deltas
  @index_config_deltas
end

#progress_bytes ⇒ 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 progressBytes

Returns:



237
238
239
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 237

def progress_bytes
  @progress_bytes
end

#progress_documents ⇒ 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 progressDocuments

Returns:



244
245
246
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 244

def progress_documents
  @progress_documents
end

#start_time ⇒ String

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

Returns:

  • (String) 


249
250
251
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 249

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


254
255
256
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 254

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



261
262
263
264
265
266
267
268
269
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 261

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @field = args[:field] if args.key?(:field)
  @index_config_deltas = args[:index_config_deltas] if args.key?(:index_config_deltas)
  @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