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



123
124
125
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 123

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

Instance Attribute Details

#bytes_progress ⇒ Google::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

Returns:



85
86
87
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 85

def bytes_progress
  @bytes_progress
end

#document_progress ⇒ Google::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

Returns:



92
93
94
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 92

def document_progress
  @document_progress
end

#end_time ⇒ String

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

Returns:

  • (String) 


98
99
100
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 98

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) 


105
106
107
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 105

def field
  @field
end

#index_config_deltas ⇒ Array<Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfigDelta>

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

Returns:



111
112
113
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 111

def index_config_deltas
  @index_config_deltas
end

#start_time ⇒ String

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

Returns:

  • (String) 


116
117
118
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 116

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


121
122
123
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 121

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



128
129
130
131
132
133
134
135
136
 
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 128

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