Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::IndexOperationMetadata (v0.11.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::IndexOperationMetadata.

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

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.

#index

def index() -> ::String

Returns

(::String) — The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

#index=

def index=(value) -> ::String

Parameter

value (::String) — The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Returns

(::String) — The index resource that this operation is acting on. For example: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

#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.