public final class ImportDocumentsMetadata extends GeneratedMessageV3 implements ImportDocumentsMetadataOrBuilder
Metadata for google.longrunning.Operation results from
FirestoreAdmin.ImportDocuments.
Protobuf type google.firestore.admin.v1.ImportDocumentsMetadata
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 INPUT_URI_PREFIX_FIELD_NUMBER
Field Value
public static final int OPERATION_STATE_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 ImportDocumentsMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ImportDocumentsMetadata.Builder newBuilder()
Returns
public static ImportDocumentsMetadata.Builder newBuilder(ImportDocumentsMetadata prototype)
Parameter
Returns
public static ImportDocumentsMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportDocumentsMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ImportDocumentsMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ImportDocumentsMetadata> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
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;
Returns
public ImportDocumentsMetadata 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 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;
Returns
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()
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 ImportDocumentsMetadata.Builder newBuilderForType()
Returns
protected ImportDocumentsMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ImportDocumentsMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions