Class: Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2FieldOperationMetadata

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.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) ⇒ GoogleFirestoreAdminV1beta2FieldOperationMetadata

Returns a new instance of GoogleFirestoreAdminV1beta2FieldOperationMetadata



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

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

Instance Attribute Details

#bytes_progressGoogle::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 bytesProgress



218
219
220
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 218

def bytes_progress
  @bytes_progress
end

#document_progressGoogle::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 documentProgress



225
226
227
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 225

def document_progress
  @document_progress
end

#end_timeString

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

Returns:

  • (String)


231
232
233
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 231

def end_time
  @end_time
end

#fieldString

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)


238
239
240
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 238

def field
  @field
end

#index_config_deltasArray<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfigDelta>

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



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

def index_config_deltas
  @index_config_deltas
end

#start_timeString

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

Returns:

  • (String)


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

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


254
255
256
# File 'generated/google/apis/firestore_v1beta2/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_v1beta2/classes.rb', line 261

def update!(**args)
  @bytes_progress = args[:bytes_progress] if args.key?(:bytes_progress)
  @document_progress = args[:document_progress] if args.key?(:document_progress)
  @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)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
end