Send feedback
Class FirestoreSource (0.72.0)
Stay organized with collections
Save and categorize content based on your preferences.
public final class FirestoreSource extends GeneratedMessageV3 implements FirestoreSourceOrBuilder
Firestore source import data from.
Protobuf type google.cloud.discoveryengine.v1beta.FirestoreSource
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLLECTION_ID_FIELD_NUMBER
public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
Type Description
int
DATABASE_ID_FIELD_NUMBER
public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int
GCS_STAGING_DIR_FIELD_NUMBER
public static final int GCS_STAGING_DIR_FIELD_NUMBER
Field Value
Type Description
int
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static FirestoreSource getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static FirestoreSource . Builder newBuilder ()
newBuilder(FirestoreSource prototype)
public static FirestoreSource . Builder newBuilder ( FirestoreSource prototype )
public static FirestoreSource parseDelimitedFrom ( InputStream input )
public static FirestoreSource parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static FirestoreSource parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirestoreSource parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static FirestoreSource parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirestoreSource parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FirestoreSource parseFrom ( CodedInputStream input )
public static FirestoreSource parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FirestoreSource parseFrom ( InputStream input )
public static FirestoreSource parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static FirestoreSource parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirestoreSource parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<FirestoreSource> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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 ()
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.
getParserForType()
public Parser<FirestoreSource> getParserForType ()
Overrides
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.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public FirestoreSource . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirestoreSource . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public FirestoreSource . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
