Class ExportDocumentsMetadata.Builder (3.22.0)

public static final class ExportDocumentsMetadata.Builder extends GeneratedMessageV3.Builder<ExportDocumentsMetadata.Builder> implements ExportDocumentsMetadataOrBuilder

Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

Protobuf type google.firestore.admin.v1.ExportDocumentsMetadata

Static Methods

getDescriptor()

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

Methods

addAllCollectionIds(Iterable<String> values)

public ExportDocumentsMetadata.Builder addAllCollectionIds(Iterable<String> values)

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameter
Name Description
values Iterable<String>

The collectionIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addAllNamespaceIds(Iterable<String> values)

public ExportDocumentsMetadata.Builder addAllNamespaceIds(Iterable<String> values)

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Parameter
Name Description
values Iterable<String>

The namespaceIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addCollectionIds(String value)

public ExportDocumentsMetadata.Builder addCollectionIds(String value)

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameter
Name Description
value String

The collectionIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addCollectionIdsBytes(ByteString value)

public ExportDocumentsMetadata.Builder addCollectionIdsBytes(ByteString value)

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameter
Name Description
value ByteString

The bytes of the collectionIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIds(String value)

public ExportDocumentsMetadata.Builder addNamespaceIds(String value)

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Parameter
Name Description
value String

The namespaceIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public ExportDocumentsMetadata.Builder addNamespaceIdsBytes(ByteString value)

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Parameter
Name Description
value ByteString

The bytes of the namespaceIds to add.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

build()

public ExportDocumentsMetadata build()
Returns
Type Description
ExportDocumentsMetadata

buildPartial()

public ExportDocumentsMetadata buildPartial()
Returns
Type Description
ExportDocumentsMetadata

clear()

public ExportDocumentsMetadata.Builder clear()
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

clearCollectionIds()

public ExportDocumentsMetadata.Builder clearCollectionIds()

Which collection ids are being exported.

repeated string collection_ids = 6;

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

clearEndTime()

public ExportDocumentsMetadata.Builder clearEndTime()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
ExportDocumentsMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public ExportDocumentsMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

clearNamespaceIds()

public ExportDocumentsMetadata.Builder clearNamespaceIds()

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportDocumentsMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

clearOperationState()

public ExportDocumentsMetadata.Builder clearOperationState()

The state of the export operation.

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

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

clearOutputUriPrefix()

public ExportDocumentsMetadata.Builder clearOutputUriPrefix()

Where the documents are being exported to.

string output_uri_prefix = 7;

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

clearProgressBytes()

public ExportDocumentsMetadata.Builder clearProgressBytes()

The progress, in bytes, of this operation.

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

Returns
Type Description
ExportDocumentsMetadata.Builder

clearProgressDocuments()

public ExportDocumentsMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

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

Returns
Type Description
ExportDocumentsMetadata.Builder

clearSnapshotTime()

public ExportDocumentsMetadata.Builder clearSnapshotTime()

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
ExportDocumentsMetadata.Builder

clearStartTime()

public ExportDocumentsMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
ExportDocumentsMetadata.Builder

clone()

public ExportDocumentsMetadata.Builder clone()
Returns
Type Description
ExportDocumentsMetadata.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

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.

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.

getProgressBytesBuilder()

public Progress.Builder getProgressBytesBuilder()

The progress, in bytes, of this operation.

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

Returns
Type Description
Progress.Builder

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.

getProgressDocumentsBuilder()

public Progress.Builder getProgressDocumentsBuilder()

The progress, in documents, of this operation.

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

Returns
Type Description
Progress.Builder

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns
Type Description
ProgressOrBuilder

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.

getSnapshotTimeBuilder()

public Timestamp.Builder getSnapshotTimeBuilder()

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
Builder

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public ExportDocumentsMetadata.Builder mergeEndTime(Timestamp value)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeFrom(ExportDocumentsMetadata other)

public ExportDocumentsMetadata.Builder mergeFrom(ExportDocumentsMetadata other)
Parameter
Name Description
other ExportDocumentsMetadata
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportDocumentsMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportDocumentsMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

mergeProgressBytes(Progress value)

public ExportDocumentsMetadata.Builder mergeProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter
Name Description
value Progress
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeProgressDocuments(Progress value)

public ExportDocumentsMetadata.Builder mergeProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter
Name Description
value Progress
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeSnapshotTime(Timestamp value)

public ExportDocumentsMetadata.Builder mergeSnapshotTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeStartTime(Timestamp value)

public ExportDocumentsMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

setCollectionIds(int index, String value)

public ExportDocumentsMetadata.Builder setCollectionIds(int index, String value)

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The collectionIds to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setEndTime(Timestamp value)

public ExportDocumentsMetadata.Builder setEndTime(Timestamp value)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public ExportDocumentsMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

The time this operation completed. Will be unset if operation still in progress.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExportDocumentsMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

setNamespaceIds(int index, String value)

public ExportDocumentsMetadata.Builder setNamespaceIds(int index, String value)

Which namespace ids are being exported.

repeated string namespace_ids = 8;

Parameters
Name Description
index int

The index to set the value at.

value String

The namespaceIds to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setOperationState(OperationState value)

public ExportDocumentsMetadata.Builder setOperationState(OperationState value)

The state of the export operation.

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

Parameter
Name Description
value OperationState

The operationState to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setOperationStateValue(int value)

public ExportDocumentsMetadata.Builder setOperationStateValue(int value)

The state of the export operation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for operationState to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setOutputUriPrefix(String value)

public ExportDocumentsMetadata.Builder setOutputUriPrefix(String value)

Where the documents are being exported to.

string output_uri_prefix = 7;

Parameter
Name Description
value String

The outputUriPrefix to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setOutputUriPrefixBytes(ByteString value)

public ExportDocumentsMetadata.Builder setOutputUriPrefixBytes(ByteString value)

Where the documents are being exported to.

string output_uri_prefix = 7;

Parameter
Name Description
value ByteString

The bytes for outputUriPrefix to set.

Returns
Type Description
ExportDocumentsMetadata.Builder

This builder for chaining.

setProgressBytes(Progress value)

public ExportDocumentsMetadata.Builder setProgressBytes(Progress value)

The progress, in bytes, of this operation.

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

Parameter
Name Description
value Progress
Returns
Type Description
ExportDocumentsMetadata.Builder

setProgressBytes(Progress.Builder builderForValue)

public ExportDocumentsMetadata.Builder setProgressBytes(Progress.Builder builderForValue)

The progress, in bytes, of this operation.

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

Parameter
Name Description
builderForValue Progress.Builder
Returns
Type Description
ExportDocumentsMetadata.Builder

setProgressDocuments(Progress value)

public ExportDocumentsMetadata.Builder setProgressDocuments(Progress value)

The progress, in documents, of this operation.

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

Parameter
Name Description
value Progress
Returns
Type Description
ExportDocumentsMetadata.Builder

setProgressDocuments(Progress.Builder builderForValue)

public ExportDocumentsMetadata.Builder setProgressDocuments(Progress.Builder builderForValue)

The progress, in documents, of this operation.

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

Parameter
Name Description
builderForValue Progress.Builder
Returns
Type Description
ExportDocumentsMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExportDocumentsMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides

setSnapshotTime(Timestamp value)

public ExportDocumentsMetadata.Builder setSnapshotTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

setSnapshotTime(Timestamp.Builder builderForValue)

public ExportDocumentsMetadata.Builder setSnapshotTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExportDocumentsMetadata.Builder

setStartTime(Timestamp value)

public ExportDocumentsMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ExportDocumentsMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public ExportDocumentsMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExportDocumentsMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportDocumentsMetadata.Builder
Overrides