Class ImportDocumentsMetadata.Builder (3.30.0)

public static final class ImportDocumentsMetadata.Builder extends GeneratedMessageV3.Builder<ImportDocumentsMetadata.Builder> implements ImportDocumentsMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.ImportDocumentsMetadata

Static Methods

getDescriptor()

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

Methods

addAllCollectionIds(Iterable<String> values)

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

Which collection IDs are being imported.

repeated string collection_ids = 6;

Parameter
Name Description
values Iterable<String>

The collectionIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addAllNamespaceIds(Iterable<String> values)

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

Which namespace IDs are being imported.

repeated string namespace_ids = 8;

Parameter
Name Description
values Iterable<String>

The namespaceIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addCollectionIds(String value)

public ImportDocumentsMetadata.Builder addCollectionIds(String value)

Which collection IDs are being imported.

repeated string collection_ids = 6;

Parameter
Name Description
value String

The collectionIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addCollectionIdsBytes(ByteString value)

public ImportDocumentsMetadata.Builder addCollectionIdsBytes(ByteString value)

Which collection IDs are being imported.

repeated string collection_ids = 6;

Parameter
Name Description
value ByteString

The bytes of the collectionIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIds(String value)

public ImportDocumentsMetadata.Builder addNamespaceIds(String value)

Which namespace IDs are being imported.

repeated string namespace_ids = 8;

Parameter
Name Description
value String

The namespaceIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public ImportDocumentsMetadata.Builder addNamespaceIdsBytes(ByteString value)

Which namespace IDs are being imported.

repeated string namespace_ids = 8;

Parameter
Name Description
value ByteString

The bytes of the namespaceIds to add.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ImportDocumentsMetadata build()
Returns
Type Description
ImportDocumentsMetadata

buildPartial()

public ImportDocumentsMetadata buildPartial()
Returns
Type Description
ImportDocumentsMetadata

clear()

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

clearCollectionIds()

public ImportDocumentsMetadata.Builder clearCollectionIds()

Which collection IDs are being imported.

repeated string collection_ids = 6;

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

clearEndTime()

public ImportDocumentsMetadata.Builder clearEndTime()

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

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
ImportDocumentsMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearInputUriPrefix()

public ImportDocumentsMetadata.Builder clearInputUriPrefix()

The location of the documents being imported.

string input_uri_prefix = 7;

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

clearNamespaceIds()

public ImportDocumentsMetadata.Builder clearNamespaceIds()

Which namespace IDs are being imported.

repeated string namespace_ids = 8;

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOperationState()

public ImportDocumentsMetadata.Builder clearOperationState()

The state of the import operation.

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

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

clearProgressBytes()

public ImportDocumentsMetadata.Builder clearProgressBytes()

The progress, in bytes, of this operation.

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

Returns
Type Description
ImportDocumentsMetadata.Builder

clearProgressDocuments()

public ImportDocumentsMetadata.Builder clearProgressDocuments()

The progress, in documents, of this operation.

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

Returns
Type Description
ImportDocumentsMetadata.Builder

clearStartTime()

public ImportDocumentsMetadata.Builder clearStartTime()

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
ImportDocumentsMetadata.Builder

clone()

public ImportDocumentsMetadata.Builder clone()
Returns
Type Description
ImportDocumentsMetadata.Builder
Overrides

getCollectionIds(int index)

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.

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

getCollectionIdsCount()

public int getCollectionIdsCount()

Which collection IDs are being imported.

repeated string collection_ids = 6;

Returns
Type Description
int

The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Which collection IDs are being imported.

repeated string collection_ids = 6;

Returns
Type Description
ProtocolStringList

A list containing the collectionIds.

getDefaultInstanceForType()

public ImportDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
ImportDocumentsMetadata

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

getInputUriPrefix()

public String getInputUriPrefix()

The location of the documents being imported.

string input_uri_prefix = 7;

Returns
Type Description
String

The inputUriPrefix.

getInputUriPrefixBytes()

public ByteString getInputUriPrefixBytes()

The location of the documents being imported.

string input_uri_prefix = 7;

Returns
Type Description
ByteString

The bytes for inputUriPrefix.

getNamespaceIds(int index)

public String getNamespaceIds(int index)

Which namespace IDs are being imported.

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 imported.

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 imported.

repeated string namespace_ids = 8;

Returns
Type Description
int

The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

Which namespace IDs are being imported.

repeated string namespace_ids = 8;

Returns
Type Description
ProtocolStringList

A list containing the namespaceIds.

getOperationState()

public OperationState getOperationState()

The state of the import operation.

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

Returns
Type Description
OperationState

The operationState.

getOperationStateValue()

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.

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

mergeFrom(ImportDocumentsMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeProgressBytes(Progress value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

mergeProgressDocuments(Progress value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

mergeStartTime(Timestamp value)

public ImportDocumentsMetadata.Builder mergeStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportDocumentsMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCollectionIds(int index, String value)

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

Which collection IDs are being imported.

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

This builder for chaining.

setEndTime(Timestamp value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setInputUriPrefix(String value)

public ImportDocumentsMetadata.Builder setInputUriPrefix(String value)

The location of the documents being imported.

string input_uri_prefix = 7;

Parameter
Name Description
value String

The inputUriPrefix to set.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

setInputUriPrefixBytes(ByteString value)

public ImportDocumentsMetadata.Builder setInputUriPrefixBytes(ByteString value)

The location of the documents being imported.

string input_uri_prefix = 7;

Parameter
Name Description
value ByteString

The bytes for inputUriPrefix to set.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

setNamespaceIds(int index, String value)

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

Which namespace IDs are being imported.

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

This builder for chaining.

setOperationState(OperationState value)

public ImportDocumentsMetadata.Builder setOperationState(OperationState value)

The state of the import operation.

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

Parameter
Name Description
value OperationState

The operationState to set.

Returns
Type Description
ImportDocumentsMetadata.Builder

This builder for chaining.

setOperationStateValue(int value)

public ImportDocumentsMetadata.Builder setOperationStateValue(int value)

The state of the import 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
ImportDocumentsMetadata.Builder

This builder for chaining.

setProgressBytes(Progress value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

setProgressBytes(Progress.Builder builderForValue)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

setProgressDocuments(Progress value)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

setProgressDocuments(Progress.Builder builderForValue)

public ImportDocumentsMetadata.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
ImportDocumentsMetadata.Builder

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

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

setStartTime(Timestamp value)

public ImportDocumentsMetadata.Builder setStartTime(Timestamp value)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ImportDocumentsMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public ImportDocumentsMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time this operation started.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ImportDocumentsMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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