- 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 FirestoreSourceOrBuilderFirestore source import data from.
Protobuf type google.cloud.discoveryengine.v1alpha.FirestoreSource
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FirestoreSource.BuilderImplements
FirestoreSourceOrBuilderStatic 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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public FirestoreSource.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
FirestoreSource.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FirestoreSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FirestoreSource.Builder |
|
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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final FirestoreSource.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FirestoreSource.Builder |
|