Send feedback
Class ImportDocumentsMetadata (3.12.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.12.1keyboard_arrow_down
public final class ImportDocumentsMetadata extends GeneratedMessageV3 implements ImportDocumentsMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.ImportDocuments .
Protobuf type google.firestore.admin.v1.ImportDocumentsMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 INPUT_URI_PREFIX_FIELD_NUMBER
Field Value
Type
Description
int
public static final int OPERATION_STATE_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 START_TIME_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
public static ImportDocumentsMetadata getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static ImportDocumentsMetadata . Builder newBuilder ()
public static ImportDocumentsMetadata . Builder newBuilder ( ImportDocumentsMetadata prototype )
public static ImportDocumentsMetadata parseDelimitedFrom ( InputStream input )
public static ImportDocumentsMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsMetadata parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
public static ImportDocumentsMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsMetadata parseFrom ( ByteString data )
public static ImportDocumentsMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsMetadata parseFrom ( CodedInputStream input )
public static ImportDocumentsMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsMetadata parseFrom ( InputStream input )
public static ImportDocumentsMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static ImportDocumentsMetadata parseFrom ( ByteBuffer data )
public static ImportDocumentsMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<ImportDocumentsMetadata> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
public String getCollectionIds ( int index )
Which collection ids are being imported.
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 imported.
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 imported.
repeated string collection_ids = 6;
Returns
Type
Description
int
The count of collectionIds.
public ProtocolStringList getCollectionIdsList ()
Which collection ids are being imported.
repeated string collection_ids = 6;
public ImportDocumentsMetadata 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 getInputUriPrefix ()
The location of the documents being imported.
string input_uri_prefix = 7;
Returns
Type
Description
String
The inputUriPrefix.
public ByteString getInputUriPrefixBytes ()
The location of the documents being imported.
string input_uri_prefix = 7;
Returns
Type
Description
ByteString
The bytes for inputUriPrefix.
public OperationState getOperationState ()
The state of the import operation.
.google.firestore.admin.v1.OperationState operation_state = 3;
public int getOperationStateValue ()
The state of the import operation.
.google.firestore.admin.v1.OperationState operation_state = 3;
Returns
Type
Description
int
The enum numeric value on the wire for operationState.
public Parser<ImportDocumentsMetadata> 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 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 final UnknownFieldSet getUnknownFields ()
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
Type
Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public ImportDocumentsMetadata . Builder newBuilderForType ()
protected ImportDocumentsMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
public ImportDocumentsMetadata . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
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-06-04 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-06-04 UTC."],[],[]]