com.google.cloud.discoveryengine.v1alpha

Class FirestoreSource.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

com.google.cloud.discoveryengine.v1alpha.FirestoreSource.Builder

All Implemented Interfaces:

FirestoreSourceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

FirestoreSource

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

 Firestore source import data from.
 

Protobuf type google.cloud.discoveryengine.v1alpha.FirestoreSource

Method Summary

Modifier and Type	Method and Description
FirestoreSource.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FirestoreSource	build()
FirestoreSource	buildPartial()
FirestoreSource.Builder	clear()
FirestoreSource.Builder	clearCollectionId() Required.
FirestoreSource.Builder	clearDatabaseId() Required.
FirestoreSource.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FirestoreSource.Builder	clearGcsStagingDir() Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
FirestoreSource.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FirestoreSource.Builder	clearProjectId() The project ID that the Cloud SQL source is in with a length limit of 128 characters.
FirestoreSource.Builder	clone()
String	getCollectionId() Required.
com.google.protobuf.ByteString	getCollectionIdBytes() Required.
String	getDatabaseId() Required.
com.google.protobuf.ByteString	getDatabaseIdBytes() Required.
FirestoreSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getGcsStagingDir() Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
com.google.protobuf.ByteString	getGcsStagingDirBytes() Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
String	getProjectId() The project ID that the Cloud SQL source is in with a length limit of 128 characters.
com.google.protobuf.ByteString	getProjectIdBytes() The project ID that the Cloud SQL source is in with a length limit of 128 characters.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FirestoreSource.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FirestoreSource.Builder	mergeFrom(FirestoreSource other)
FirestoreSource.Builder	mergeFrom(com.google.protobuf.Message other)
FirestoreSource.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FirestoreSource.Builder	setCollectionId(String value) Required.
FirestoreSource.Builder	setCollectionIdBytes(com.google.protobuf.ByteString value) Required.
FirestoreSource.Builder	setDatabaseId(String value) Required.
FirestoreSource.Builder	setDatabaseIdBytes(com.google.protobuf.ByteString value) Required.
FirestoreSource.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FirestoreSource.Builder	setGcsStagingDir(String value) Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
FirestoreSource.Builder	setGcsStagingDirBytes(com.google.protobuf.ByteString value) Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters.
FirestoreSource.Builder	setProjectId(String value) The project ID that the Cloud SQL source is in with a length limit of 128 characters.
FirestoreSource.Builder	setProjectIdBytes(com.google.protobuf.ByteString value) The project ID that the Cloud SQL source is in with a length limit of 128 characters.
FirestoreSource.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FirestoreSource.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

clear

public FirestoreSource.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

getDefaultInstanceForType

public FirestoreSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FirestoreSource build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FirestoreSource buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public FirestoreSource.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

clearField

public FirestoreSource.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

clearOneof

public FirestoreSource.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

mergeFrom

public FirestoreSource.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirestoreSource.Builder>

mergeFrom

public FirestoreSource.Builder mergeFrom(FirestoreSource other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

mergeFrom

public FirestoreSource.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirestoreSource.Builder>

Throws:

IOException

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;

Specified by:

getProjectId in interface FirestoreSourceOrBuilder

Returns:

The projectId.

getProjectIdBytes

public com.google.protobuf.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;

Specified by:

getProjectIdBytes in interface FirestoreSourceOrBuilder

Returns:

The bytes for projectId.

setProjectId

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;

Parameters:

value - The projectId to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setProjectIdBytes

public FirestoreSource.Builder setProjectIdBytes(com.google.protobuf.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;

Parameters:

value - The bytes for projectId to set.

Returns:

This builder for chaining.

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];

Specified by:

getDatabaseId in interface FirestoreSourceOrBuilder

Returns:

The databaseId.

getDatabaseIdBytes

public com.google.protobuf.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];

Specified by:

getDatabaseIdBytes in interface FirestoreSourceOrBuilder

Returns:

The bytes for databaseId.

setDatabaseId

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];

Parameters:

value - The databaseId to set.

Returns:

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:

This builder for chaining.

setDatabaseIdBytes

public FirestoreSource.Builder setDatabaseIdBytes(com.google.protobuf.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];

Parameters:

value - The bytes for databaseId to set.

Returns:

This builder for chaining.

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];

Specified by:

getCollectionId in interface FirestoreSourceOrBuilder

Returns:

The collectionId.

getCollectionIdBytes

public com.google.protobuf.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];

Specified by:

getCollectionIdBytes in interface FirestoreSourceOrBuilder

Returns:

The bytes for collectionId.

setCollectionId

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];

Parameters:

value - The collectionId to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setCollectionIdBytes

public FirestoreSource.Builder setCollectionIdBytes(com.google.protobuf.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];

Parameters:

value - The bytes for collectionId to set.

Returns:

This builder for chaining.

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;

Specified by:

getGcsStagingDir in interface FirestoreSourceOrBuilder

Returns:

The gcsStagingDir.

getGcsStagingDirBytes

public com.google.protobuf.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;

Specified by:

getGcsStagingDirBytes in interface FirestoreSourceOrBuilder

Returns:

The bytes for gcsStagingDir.

setGcsStagingDir

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;

Parameters:

value - The gcsStagingDir to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setGcsStagingDirBytes

public FirestoreSource.Builder setGcsStagingDirBytes(com.google.protobuf.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;

Parameters:

value - The bytes for gcsStagingDir to set.

Returns:

This builder for chaining.

setUnknownFields

public final FirestoreSource.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>

mergeUnknownFields

public final FirestoreSource.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FirestoreSource.Builder>