Class ExportDocumentsMetadata (3.21.3)

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

COLLECTION_IDS_FIELD_NUMBER

public static final int COLLECTION_IDS_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAMESPACE_IDS_FIELD_NUMBER

public static final int NAMESPACE_IDS_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_STATE_FIELD_NUMBER

public static final int OPERATION_STATE_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_URI_PREFIX_FIELD_NUMBER

public static final int OUTPUT_URI_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_BYTES_FIELD_NUMBER

public static final int PROGRESS_BYTES_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_DOCUMENTS_FIELD_NUMBER

public static final int PROGRESS_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_TIME_FIELD_NUMBER

public static final int SNAPSHOT_TIME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportDocumentsMetadata getDefaultInstance()
Returns
Type Description
ExportDocumentsMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExportDocumentsMetadata.Builder newBuilder()
Returns
Type Description
ExportDocumentsMetadata.Builder

newBuilder(ExportDocumentsMetadata prototype)

public static ExportDocumentsMetadata.Builder newBuilder(ExportDocumentsMetadata prototype)
Parameter
Name Description
prototype ExportDocumentsMetadata
Returns
Type Description
ExportDocumentsMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportDocumentsMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportDocumentsMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportDocumentsMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportDocumentsMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportDocumentsMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportDocumentsMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportDocumentsMetadata> parser()
Returns
Type Description
Parser<ExportDocumentsMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollectionIds(int index)

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.

getCollectionIdsBytes(int 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.

getCollectionIdsCount()

public int getCollectionIdsCount()

Which collection ids are being exported.

repeated string collection_ids = 6;

Returns
Type Description
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Which collection ids are being exported.

repeated string collection_ids = 6;

Returns
Type Description
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ExportDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
ExportDocumentsMetadata

getEndTime()

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.

getEndTimeOrBuilder()

public 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 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 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 int getNamespaceIdsCount()

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Returns
Type Description
int

The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Returns
Type Description
ProtocolStringList

A list containing the namespaceIds.

getOperationState()

public OperationState getOperationState()

The state of the export operation.

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

Returns
Type Description
OperationState

The operationState.

getOperationStateValue()

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.

getOutputUriPrefix()

public String getOutputUriPrefix()

Where the documents are being exported to.

string output_uri_prefix = 7;

Returns
Type Description
String

The outputUriPrefix.

getOutputUriPrefixBytes()

public ByteString getOutputUriPrefixBytes()

Where the documents are being exported to.

string output_uri_prefix = 7;

Returns
Type Description
ByteString

The bytes for outputUriPrefix.

getParserForType()

public Parser<ExportDocumentsMetadata> getParserForType()
Returns
Type Description
Parser<ExportDocumentsMetadata>
Overrides

getProgressBytes()

public 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 ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

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

Returns
Type Description
ProgressOrBuilder

getProgressDocuments()

public 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 ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns
Type Description
ProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSnapshotTime()

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.

getSnapshotTimeOrBuilder()

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;

Returns
Type Description
TimestampOrBuilder

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

hasEndTime()

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.

hasProgressBytes()

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.

hasProgressDocuments()

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.

hasSnapshotTime()

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.

hasStartTime()

public boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportDocumentsMetadata.Builder newBuilderForType()
Returns
Type Description
ExportDocumentsMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportDocumentsMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportDocumentsMetadata.Builder toBuilder()
Returns
Type Description
ExportDocumentsMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException