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

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 google.longrunning.Operation results from FirestoreAdmin. UpdateField.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1FieldOperationMetadata

Returns a new instance of GoogleFirestoreAdminV1FieldOperationMetadata.



1456
1457
1458
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1456

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) 


1415
1416
1417
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1415

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) 


1422
1423
1424
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1422

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:



1427
1428
1429
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1427

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:



1433
1434
1435
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1433

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:



1439
1440
1441
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1439

def progress_documents
  @progress_documents
end

#start_time ⇒ String

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

Returns:

  • (String) 


1444
1445
1446
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1444

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1449
1450
1451
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1449

def state
  @state
end

#ttl_config_delta ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfigDelta

Information about a TTL configuration change. Corresponds to the JSON property ttlConfigDelta

Returns:



1454
1455
1456
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1454

def ttl_config_delta
  @ttl_config_delta
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1461

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)
  @ttl_config_delta = args[:ttl_config_delta] if args.key?(:ttl_config_delta)
end