Send feedback
Class ExportDocumentsMetadata (3.7.9)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.7.9 keyboard_arrow_down
public final class ExportDocumentsMetadata extends GeneratedMessageV3 implements ExportDocumentsMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.ExportDocuments .
Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata
Static Fields
public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int OPERATION_STATE_FIELD_NUMBER
Field Value
public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
Field Value
public static final int PROGRESS_BYTES_FIELD_NUMBER
Field Value
public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
Static Methods
public static ExportDocumentsMetadata getDefaultInstance ()
Returns
public static final Descriptors . Descriptor getDescriptor ()
Returns
public static ExportDocumentsMetadata . Builder newBuilder ()
Returns
public static ExportDocumentsMetadata . Builder newBuilder ( ExportDocumentsMetadata prototype )
Parameter
Returns
public static ExportDocumentsMetadata parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ExportDocumentsMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( ByteString data )
Parameter
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
public static ExportDocumentsMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Parser<ExportDocumentsMetadata> parser ()
Returns
Methods
public boolean equals ( Object obj )
Parameter
Returns
Overrides
public String getCollectionIds ( int index )
Which collection ids are being exported.
repeated string collection_ids = 6;
Parameter
Name Description indexint 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 indexint 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;
Returns
public ExportDocumentsMetadata getDefaultInstanceForType ()
Returns
public Timestamp getEndTime ()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
Returns
public TimestampOrBuilder getEndTimeOrBuilder ()
The time this operation completed. Will be unset if operation still in
progress.
.google.protobuf.Timestamp end_time = 2;
Returns
public OperationState getOperationState ()
The state of the export operation.
.google.firestore.admin.v1.OperationState operation_state = 3;
Returns
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 entities are being exported to.
string output_uri_prefix = 7;
Returns
Type Description String The outputUriPrefix.
public ByteString getOutputUriPrefixBytes ()
Where the entities are being exported to.
string output_uri_prefix = 7;
Returns
Type Description ByteString The bytes for outputUriPrefix.
public Parser<ExportDocumentsMetadata> getParserForType ()
Returns
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;
Returns
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;
Returns
public int getSerializedSize ()
Returns
Overrides
public Timestamp getStartTime ()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
Returns
public TimestampOrBuilder getStartTimeOrBuilder ()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
Returns
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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 hasStartTime ()
The time this operation started.
.google.protobuf.Timestamp start_time = 1;
Returns
Type Description boolean Whether the startTime field is set.
Returns
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
public final boolean isInitialized ()
Returns
Overrides
public ExportDocumentsMetadata . Builder newBuilderForType ()
Returns
protected ExportDocumentsMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
public ExportDocumentsMetadata . Builder toBuilder ()
Returns
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
