Class ExportDocumentsMetadata.Builder (3.0.21)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportDocumentsMetadata.Builder

Implements

ExportDocumentsMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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.

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.

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportDocumentsMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ExportDocumentsMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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 entities 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

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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 entities are being exported to.

string output_uri_prefix = 7;

Returns

Type	Description
String	The outputUriPrefix.

getOutputUriPrefixBytes()

public ByteString getOutputUriPrefixBytes()

Where the entities 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

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.

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ExportDocumentsMetadata.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ExportDocumentsMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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 entities 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 entities 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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)