Class FirestoreSource (0.44.0)

public final class FirestoreSource extends GeneratedMessageV3 implements FirestoreSourceOrBuilder

Firestore source import data from.

Protobuf type google.cloud.discoveryengine.v1.FirestoreSource

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()
Returns
Type Description
FirestoreSource

getDescriptor()

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

newBuilder()

public static FirestoreSource.Builder newBuilder()
Returns
Type Description
FirestoreSource.Builder

newBuilder(FirestoreSource prototype)

public static FirestoreSource.Builder newBuilder(FirestoreSource prototype)
Parameter
Name Description
prototype FirestoreSource
Returns
Type Description
FirestoreSource.Builder

parseDelimitedFrom(InputStream input)

public static FirestoreSource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FirestoreSource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FirestoreSource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FirestoreSource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FirestoreSource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FirestoreSource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirestoreSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FirestoreSource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FirestoreSource> parser()
Returns
Type Description
Parser<FirestoreSource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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()
Returns
Type Description
Parser<FirestoreSource>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FirestoreSource.Builder newBuilderForType()
Returns
Type Description
FirestoreSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FirestoreSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FirestoreSource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FirestoreSource.Builder toBuilder()
Returns
Type Description
FirestoreSource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException