Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata.
Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
Returns
- (::Google::Protobuf::Timestamp) — The time this operation completed. Will be unset if operation still in progress.
#field
def field() -> ::String
Returns
-
(::String) — The field resource that this operation is acting on. For example:
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
#field=
def field=(value) -> ::String
Parameter
-
value (::String) — The field resource that this operation is acting on. For example:
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
Returns
-
(::String) — The field resource that this operation is acting on. For example:
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
#index_config_deltas
def index_config_deltas() -> ::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>
Returns
- (::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>) — A list of IndexConfigDelta, which describe the intent of this operation.
#index_config_deltas=
def index_config_deltas=(value) -> ::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>
Parameter
- value (::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>) — A list of IndexConfigDelta, which describe the intent of this operation.
Returns
- (::Array<::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta>) — A list of IndexConfigDelta, which describe the intent of this operation.
#progress_bytes
def progress_bytes() -> ::Google::Cloud::Firestore::Admin::V1::Progress
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
#progress_bytes=
def progress_bytes=(value) -> ::Google::Cloud::Firestore::Admin::V1::Progress
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in bytes, of this operation.
#progress_documents
def progress_documents() -> ::Google::Cloud::Firestore::Admin::V1::Progress
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
#progress_documents=
def progress_documents=(value) -> ::Google::Cloud::Firestore::Admin::V1::Progress
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::Progress) — The progress, in documents, of this operation.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time this operation started.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time this operation started.
Returns
- (::Google::Protobuf::Timestamp) — The time this operation started.
#state
def state() -> ::Google::Cloud::Firestore::Admin::V1::OperationState
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
#state=
def state=(value) -> ::Google::Cloud::Firestore::Admin::V1::OperationState
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
Returns
- (::Google::Cloud::Firestore::Admin::V1::OperationState) — The state of the operation.
#ttl_config_delta
def ttl_config_delta() -> ::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta
Returns
- (::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta) — Describes the deltas of TTL configuration.
#ttl_config_delta=
def ttl_config_delta=(value) -> ::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta
Parameter
- value (::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta) — Describes the deltas of TTL configuration.
Returns
- (::Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta) — Describes the deltas of TTL configuration.