Class ExportDocumentsMetadata.Builder

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

Methods

addAllCollectionIds(Iterable<String> values)

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

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameter
NameDescription
valuesIterable<String>

The collectionIds to add.

Returns
TypeDescription
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
NameDescription
valueString

The collectionIds to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the collectionIds to add.

Returns
TypeDescription
ExportDocumentsMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

build()

public ExportDocumentsMetadata build()
Returns
TypeDescription
ExportDocumentsMetadata

buildPartial()

public ExportDocumentsMetadata buildPartial()
Returns
TypeDescription
ExportDocumentsMetadata

clear()

public ExportDocumentsMetadata.Builder clear()
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

clearCollectionIds()

public ExportDocumentsMetadata.Builder clearCollectionIds()

Which collection ids are being exported.

repeated string collection_ids = 6;

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

clearField(Descriptors.FieldDescriptor field)

public ExportDocumentsMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportDocumentsMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

clearOperationState()

public ExportDocumentsMetadata.Builder clearOperationState()

The state of the export operation.

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

Returns
TypeDescription
ExportDocumentsMetadata.Builder

This builder for chaining.

clearOutputUriPrefix()

public ExportDocumentsMetadata.Builder clearOutputUriPrefix()

Where the entities are being exported to.

string output_uri_prefix = 7;

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

clearProgressDocuments()

public ExportDocumentsMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

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

Returns
TypeDescription
ExportDocumentsMetadata.Builder

clearStartTime()

public ExportDocumentsMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
ExportDocumentsMetadata.Builder

clone()

public ExportDocumentsMetadata.Builder clone()
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

getCollectionIds(int index)

public String getCollectionIds(int index)

Which collection ids are being exported.

repeated string collection_ids = 6;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Which collection ids are being exported.

repeated string collection_ids = 6;

Returns
TypeDescription
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ExportDocumentsMetadata getDefaultInstanceForType()
Returns
TypeDescription
ExportDocumentsMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getOperationState()

public OperationState getOperationState()

The state of the export operation.

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

Returns
TypeDescription
OperationState

The operationState.

getOperationStateValue()

public int getOperationStateValue()

The state of the export operation.

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

Returns
TypeDescription
int

The enum numeric value on the wire for operationState.

getOutputUriPrefix()

public String getOutputUriPrefix()

Where the entities are being exported to.

string output_uri_prefix = 7;

Returns
TypeDescription
String

The outputUriPrefix.

getOutputUriPrefixBytes()

public ByteString getOutputUriPrefixBytes()

Where the entities are being exported to.

string output_uri_prefix = 7;

Returns
TypeDescription
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
TypeDescription
Progress

The progressBytes.

getProgressBytesBuilder()

public Progress.Builder getProgressBytesBuilder()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
Progress.Builder

getProgressBytesOrBuilder()

public ProgressOrBuilder getProgressBytesOrBuilder()

The progress, in bytes, of this operation.

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

Returns
TypeDescription
ProgressOrBuilder

getProgressDocuments()

public Progress getProgressDocuments()

The progress, in documents, of this operation.

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

Returns
TypeDescription
Progress

The progressDocuments.

getProgressDocumentsBuilder()

public Progress.Builder getProgressDocumentsBuilder()

The progress, in documents, of this operation.

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

Returns
TypeDescription
Progress.Builder

getProgressDocumentsOrBuilder()

public ProgressOrBuilder getProgressDocumentsOrBuilder()

The progress, in documents, of this operation.

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

Returns
TypeDescription
ProgressOrBuilder

getStartTime()

public Timestamp getStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the progressDocuments field is set.

hasStartTime()

public boolean hasStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
ExportDocumentsMetadata.Builder

mergeFrom(ExportDocumentsMetadata other)

public ExportDocumentsMetadata.Builder mergeFrom(ExportDocumentsMetadata other)
Parameter
NameDescription
otherExportDocumentsMetadata
Returns
TypeDescription
ExportDocumentsMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportDocumentsMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExportDocumentsMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueProgress
Returns
TypeDescription
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
NameDescription
valueProgress
Returns
TypeDescription
ExportDocumentsMetadata.Builder

mergeStartTime(Timestamp value)

public ExportDocumentsMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ExportDocumentsMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The collectionIds to set.

Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExportDocumentsMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExportDocumentsMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

setOperationState(OperationState value)

public ExportDocumentsMetadata.Builder setOperationState(OperationState value)

The state of the export operation.

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

Parameter
NameDescription
valueOperationState

The operationState to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
ExportDocumentsMetadata.Builder

This builder for chaining.

setOutputUriPrefix(String value)

public ExportDocumentsMetadata.Builder setOutputUriPrefix(String value)

Where the entities are being exported to.

string output_uri_prefix = 7;

Parameter
NameDescription
valueString

The outputUriPrefix to set.

Returns
TypeDescription
ExportDocumentsMetadata.Builder

This builder for chaining.

setOutputUriPrefixBytes(ByteString value)

public ExportDocumentsMetadata.Builder setOutputUriPrefixBytes(ByteString value)

Where the entities are being exported to.

string output_uri_prefix = 7;

Parameter
NameDescription
valueByteString

The bytes for outputUriPrefix to set.

Returns
TypeDescription
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
NameDescription
valueProgress
Returns
TypeDescription
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
NameDescription
builderForValueProgress.Builder
Returns
TypeDescription
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
NameDescription
valueProgress
Returns
TypeDescription
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
NameDescription
builderForValueProgress.Builder
Returns
TypeDescription
ExportDocumentsMetadata.Builder

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

public ExportDocumentsMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides

setStartTime(Timestamp value)

public ExportDocumentsMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExportDocumentsMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportDocumentsMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportDocumentsMetadata.Builder
Overrides