Class FirestoreSource.Builder (0.40.0)

Version 0.40.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class FirestoreSource.Builder extends GeneratedMessageV3.Builder<FirestoreSource.Builder> implements FirestoreSourceOrBuilder

Firestore source import data from.

Protobuf type google.cloud.discoveryengine.v1beta.FirestoreSource

Inheritance

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

Implements

FirestoreSourceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FirestoreSource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

build()

public FirestoreSource build()

Returns
Type	Description
FirestoreSource

buildPartial()

public FirestoreSource buildPartial()

Returns
Type	Description
FirestoreSource

clear()

public FirestoreSource.Builder clear()

Returns
Type	Description
FirestoreSource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCollectionId()

public FirestoreSource.Builder clearCollectionId()

Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.

string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

clearDatabaseId()

public FirestoreSource.Builder clearDatabaseId()

Required. The Firestore database to copy the data from with a length limit of 256 characters.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FirestoreSource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

clearGcsStagingDir()

public FirestoreSource.Builder clearGcsStagingDir()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

string gcs_staging_dir = 4;

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FirestoreSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

clearProjectId()

public FirestoreSource.Builder clearProjectId()

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

clone()

public FirestoreSource.Builder clone()

Returns
Type	Description
FirestoreSource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCollectionId()

public String getCollectionId()

Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.

string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.

string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for collectionId.

getDatabaseId()

public String getDatabaseId()

Required. The Firestore database to copy the data from with a length limit of 256 characters.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The Firestore database to copy the data from with a length limit of 256 characters.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for databaseId.

getDefaultInstanceForType()

public FirestoreSource getDefaultInstanceForType()

Returns
Type	Description
FirestoreSource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGcsStagingDir()

public String getGcsStagingDir()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

string gcs_staging_dir = 4;

Returns
Type	Description
String	The gcsStagingDir.

getGcsStagingDirBytes()

public ByteString getGcsStagingDirBytes()

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

string gcs_staging_dir = 4;

Returns
Type	Description
ByteString	The bytes for gcsStagingDir.

getProjectId()

public String getProjectId()

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Returns
Type	Description
String	The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Returns
Type	Description
ByteString	The bytes for projectId.

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()

mergeFrom(FirestoreSource other)

public FirestoreSource.Builder mergeFrom(FirestoreSource other)

Parameter
Name	Description
other	FirestoreSource

Returns
Type	Description
FirestoreSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FirestoreSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FirestoreSource.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FirestoreSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

setCollectionId(String value)

public FirestoreSource.Builder setCollectionId(String value)

Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.

string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The collectionId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setCollectionIdBytes(ByteString value)

public FirestoreSource.Builder setCollectionIdBytes(ByteString value)

Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.

string collection_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for collectionId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setDatabaseId(String value)

public FirestoreSource.Builder setDatabaseId(String value)

Required. The Firestore database to copy the data from with a length limit of 256 characters.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The databaseId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setDatabaseIdBytes(ByteString value)

public FirestoreSource.Builder setDatabaseIdBytes(ByteString value)

Required. The Firestore database to copy the data from with a length limit of 256 characters.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for databaseId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FirestoreSource.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

setGcsStagingDir(String value)

public FirestoreSource.Builder setGcsStagingDir(String value)

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

string gcs_staging_dir = 4;

Parameter
Name	Description
value	String The gcsStagingDir to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setGcsStagingDirBytes(ByteString value)

public FirestoreSource.Builder setGcsStagingDirBytes(ByteString value)

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

string gcs_staging_dir = 4;

Parameter
Name	Description
value	ByteString The bytes for gcsStagingDir to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setProjectId(String value)

public FirestoreSource.Builder setProjectId(String value)

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Parameter
Name	Description
value	String The projectId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public FirestoreSource.Builder setProjectIdBytes(ByteString value)

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

string project_id = 1;

Parameter
Name	Description
value	ByteString The bytes for projectId to set.

Returns
Type	Description
FirestoreSource.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
FirestoreSource.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final FirestoreSource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FirestoreSource.Builder

Overrides

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