Interface ExportDocumentsMetadataOrBuilder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface ExportDocumentsMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionIds(int index)

public abstract String getCollectionIds(int index)

Which collection IDs are being exported.

repeated string collection_ids = 6;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The collectionIds at the given index.

getCollectionIdsBytes(int index)

public abstract ByteString getCollectionIdsBytes(int index)

Which collection IDs are being exported.

repeated string collection_ids = 6;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public abstract int getCollectionIdsCount()

Which collection IDs are being exported.

repeated string collection_ids = 6;

Returns
Type	Description
int	The count of collectionIds.

getCollectionIdsList()

public abstract List<String> getCollectionIdsList()

Which collection IDs are being exported.

repeated string collection_ids = 6;

Returns
Type	Description
List<String>	A list containing the collectionIds.

getEndTime()

public abstract Timestamp getEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type	Description
TimestampOrBuilder

getNamespaceIds(int index)

public abstract String getNamespaceIds(int index)

Which namespace IDs are being exported.

repeated string namespace_ids = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The namespaceIds at the given index.

getNamespaceIdsBytes(int index)

public abstract ByteString getNamespaceIdsBytes(int index)

Which namespace IDs are being exported.

repeated string namespace_ids = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the namespaceIds at the given index.

getNamespaceIdsCount()

public abstract int getNamespaceIdsCount()

Which namespace IDs are being exported.

repeated string namespace_ids = 8;

Returns
Type	Description
int	The count of namespaceIds.

getNamespaceIdsList()

public abstract List<String> getNamespaceIdsList()

Which namespace IDs are being exported.

repeated string namespace_ids = 8;

Returns
Type	Description
List<String>	A list containing the namespaceIds.

getOperationState()

public abstract OperationState getOperationState()

The state of the export operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
Type	Description
OperationState	The operationState.

getOperationStateValue()

public abstract int getOperationStateValue()

The state of the export operation.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
Type	Description
int	The enum numeric value on the wire for operationState.

getOutputUriPrefix()

public abstract String getOutputUriPrefix()

Where the documents are being exported to.

string output_uri_prefix = 7;

Returns
Type	Description
String	The outputUriPrefix.

getOutputUriPrefixBytes()

public abstract ByteString getOutputUriPrefixBytes()

Where the documents are being exported to.

string output_uri_prefix = 7;

Returns
Type	Description
ByteString	The bytes for outputUriPrefix.

getProgressBytes()

public abstract Progress getProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type	Description
Progress	The progressBytes.

getProgressBytesOrBuilder()

public abstract ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type	Description
ProgressOrBuilder

getProgressDocuments()

public abstract Progress getProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type	Description
Progress	The progressDocuments.

getProgressDocumentsOrBuilder()

public abstract ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type	Description
ProgressOrBuilder

getSnapshotTime()

public abstract Timestamp getSnapshotTime()

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.

.google.protobuf.Timestamp snapshot_time = 9;

Returns
Type	Description
Timestamp	The snapshotTime.

getSnapshotTimeOrBuilder()

public abstract TimestampOrBuilder getSnapshotTimeOrBuilder()

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.

.google.protobuf.Timestamp snapshot_time = 9;

Returns
Type	Description
TimestampOrBuilder

getStartTime()

public abstract Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type	Description
TimestampOrBuilder

hasEndTime()

public abstract boolean hasEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type	Description
boolean	Whether the endTime field is set.

hasProgressBytes()

public abstract boolean hasProgressBytes()

The progress, in bytes, of this operation.

.google.firestore.admin.v1.Progress progress_bytes = 5;

Returns
Type	Description
boolean	Whether the progressBytes field is set.

hasProgressDocuments()

public abstract boolean hasProgressDocuments()

The progress, in documents, of this operation.

.google.firestore.admin.v1.Progress progress_documents = 4;

Returns
Type	Description
boolean	Whether the progressDocuments field is set.

hasSnapshotTime()

public abstract boolean hasSnapshotTime()

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported.

.google.protobuf.Timestamp snapshot_time = 9;

Returns
Type	Description
boolean	Whether the snapshotTime field is set.

hasStartTime()

public abstract boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type	Description
boolean	Whether the startTime field is set.