public final class ExportDocumentsMetadata extends GeneratedMessageV3 implements ExportDocumentsMetadataOrBuilder
Metadata for google.longrunning.Operation
results from
FirestoreAdmin.ExportDocuments.
Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int COLLECTION_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAMESPACE_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OPERATION_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROGRESS_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SNAPSHOT_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ExportDocumentsMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ExportDocumentsMetadata.Builder newBuilder()
public static ExportDocumentsMetadata.Builder newBuilder(ExportDocumentsMetadata prototype)
public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input)
public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ExportDocumentsMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsMetadata parseFrom(ByteString data)
public static ExportDocumentsMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsMetadata parseFrom(CodedInputStream input)
public static ExportDocumentsMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsMetadata parseFrom(InputStream input)
public static ExportDocumentsMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDocumentsMetadata parseFrom(ByteBuffer data)
public static ExportDocumentsMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ExportDocumentsMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public 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.
|
public 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.
|
public int getCollectionIdsCount()
Which collection IDs are being exported.
repeated string collection_ids = 6;
| Returns |
| Type |
Description |
int |
The count of collectionIds.
|
public ProtocolStringList getCollectionIdsList()
Which collection IDs are being exported.
repeated string collection_ids = 6;
public ExportDocumentsMetadata getDefaultInstanceForType()
public 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.
|
public TimestampOrBuilder getEndTimeOrBuilder()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
public 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.
|
public 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.
|
public int getNamespaceIdsCount()
Which namespace IDs are being exported.
repeated string namespace_ids = 8;
| Returns |
| Type |
Description |
int |
The count of namespaceIds.
|
public ProtocolStringList getNamespaceIdsList()
Which namespace IDs are being exported.
repeated string namespace_ids = 8;
public OperationState getOperationState()
The state of the export operation.
.google.firestore.admin.v1.OperationState operation_state = 3;
public 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.
|
public String getOutputUriPrefix()
Where the documents are being exported to.
string output_uri_prefix = 7;
| Returns |
| Type |
Description |
String |
The outputUriPrefix.
|
public ByteString getOutputUriPrefixBytes()
Where the documents are being exported to.
string output_uri_prefix = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for outputUriPrefix.
|
public Parser<ExportDocumentsMetadata> getParserForType()
Overrides
public Progress getProgressBytes()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 5;
| Returns |
| Type |
Description |
Progress |
The progressBytes.
|
public ProgressOrBuilder getProgressBytesOrBuilder()
The progress, in bytes, of this operation.
.google.firestore.admin.v1.Progress progress_bytes = 5;
public Progress getProgressDocuments()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 4;
| Returns |
| Type |
Description |
Progress |
The progressDocuments.
|
public ProgressOrBuilder getProgressDocumentsOrBuilder()
The progress, in documents, of this operation.
.google.firestore.admin.v1.Progress progress_documents = 4;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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.
|
public 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;
public Timestamp getStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
| Returns |
| Type |
Description |
Timestamp |
The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public boolean hasStartTime()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
| Returns |
| Type |
Description |
boolean |
Whether the startTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ExportDocumentsMetadata.Builder newBuilderForType()
protected ExportDocumentsMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ExportDocumentsMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
