Class FirestoreSource.Builder (0.42.0)

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

Firestore source import data from.

Protobuf type google.cloud.discoveryengine.v1alpha.FirestoreSource

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

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

clearCollectionId()

public FirestoreSource.Builder clearCollectionId()

Required. The Firestore collection (or entity) 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

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

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

getCollectionId()

public String getCollectionId()

Required. The Firestore collection (or entity) 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 (or entity) 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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCollectionId(String value)

public FirestoreSource.Builder setCollectionId(String value)

Required. The Firestore collection (or entity) 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 (or entity) 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

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

setUnknownFields(UnknownFieldSet unknownFields)

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