Class FirestoreDatabaseReference.Builder (0.27.0)

0.27.0 (latest) 0.23.0 0.22.0 0.21.0 0.19.0 0.16.0 0.15.0 0.13.0 0.11.0 0.10.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class FirestoreDatabaseReference.Builder extends GeneratedMessage.Builder<FirestoreDatabaseReference.Builder> implements FirestoreDatabaseReferenceOrBuilder

Message representing a reference to a single Firestore database.

Protobuf type google.cloud.geminidataanalytics.v1beta.FirestoreDatabaseReference

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > FirestoreDatabaseReference.Builder

Implements

FirestoreDatabaseReferenceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllCollectionIds(Iterable<String> values)

public FirestoreDatabaseReference.Builder addAllCollectionIds(Iterable<String> values)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<String> The collectionIds to add.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

addAllDatabaseTableReferences(Iterable<? extends DatabaseTableReference> values)

public FirestoreDatabaseReference.Builder addAllDatabaseTableReferences(Iterable<? extends DatabaseTableReference> values)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.geminidataanalytics.v1beta.DatabaseTableReference>

Returns
Type	Description
FirestoreDatabaseReference.Builder

addCollectionIds(String value)

public FirestoreDatabaseReference.Builder addCollectionIds(String value)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The collectionIds to add.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

addCollectionIdsBytes(ByteString value)

public FirestoreDatabaseReference.Builder addCollectionIdsBytes(ByteString value)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes of the collectionIds to add.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

addDatabaseTableReferences(DatabaseTableReference value)

public FirestoreDatabaseReference.Builder addDatabaseTableReferences(DatabaseTableReference value)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DatabaseTableReference

Returns
Type	Description
FirestoreDatabaseReference.Builder

addDatabaseTableReferences(DatabaseTableReference.Builder builderForValue)

public FirestoreDatabaseReference.Builder addDatabaseTableReferences(DatabaseTableReference.Builder builderForValue)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DatabaseTableReference.Builder

Returns
Type	Description
FirestoreDatabaseReference.Builder

addDatabaseTableReferences(int index, DatabaseTableReference value)

public FirestoreDatabaseReference.Builder addDatabaseTableReferences(int index, DatabaseTableReference value)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DatabaseTableReference

Returns
Type	Description
FirestoreDatabaseReference.Builder

addDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

public FirestoreDatabaseReference.Builder addDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DatabaseTableReference.Builder

Returns
Type	Description
FirestoreDatabaseReference.Builder

addDatabaseTableReferencesBuilder()

public DatabaseTableReference.Builder addDatabaseTableReferencesBuilder()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DatabaseTableReference.Builder

addDatabaseTableReferencesBuilder(int index)

public DatabaseTableReference.Builder addDatabaseTableReferencesBuilder(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseTableReference.Builder

build()

public FirestoreDatabaseReference build()

Returns
Type	Description
FirestoreDatabaseReference

buildPartial()

public FirestoreDatabaseReference buildPartial()

Returns
Type	Description
FirestoreDatabaseReference

clear()

public FirestoreDatabaseReference.Builder clear()

Returns
Type	Description
FirestoreDatabaseReference.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCollectionIds()

public FirestoreDatabaseReference.Builder clearCollectionIds()

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

clearDatabaseId()

public FirestoreDatabaseReference.Builder clearDatabaseId()

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

clearDatabaseTableReferences()

public FirestoreDatabaseReference.Builder clearDatabaseTableReferences()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FirestoreDatabaseReference.Builder

clearProjectId()

public FirestoreDatabaseReference.Builder clearProjectId()

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

getCollectionIds(int index)

public String getCollectionIds(int index)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The collectionIds at the given index.

getCollectionIdsBytes(int index)

public ByteString getCollectionIdsBytes(int index)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public int getCollectionIdsCount()

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the collectionIds.

getDatabaseId()

public String getDatabaseId()

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for databaseId.

getDatabaseTableReferences(int index)

public DatabaseTableReference getDatabaseTableReferences(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseTableReference

getDatabaseTableReferencesBuilder(int index)

public DatabaseTableReference.Builder getDatabaseTableReferencesBuilder(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseTableReference.Builder

getDatabaseTableReferencesBuilderList()

public List<DatabaseTableReference.Builder> getDatabaseTableReferencesBuilderList()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getDatabaseTableReferencesCount()

public int getDatabaseTableReferencesCount()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getDatabaseTableReferencesList()

public List<DatabaseTableReference> getDatabaseTableReferencesList()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<DatabaseTableReference>

getDatabaseTableReferencesOrBuilder(int index)

public DatabaseTableReferenceOrBuilder getDatabaseTableReferencesOrBuilder(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DatabaseTableReferenceOrBuilder

getDatabaseTableReferencesOrBuilderList()

public List<? extends DatabaseTableReferenceOrBuilder> getDatabaseTableReferencesOrBuilderList()

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.DatabaseTableReferenceOrBuilder>

getDefaultInstanceForType()

public FirestoreDatabaseReference getDefaultInstanceForType()

Returns
Type	Description
FirestoreDatabaseReference

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getProjectId()

public String getProjectId()

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for projectId.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(FirestoreDatabaseReference other)

public FirestoreDatabaseReference.Builder mergeFrom(FirestoreDatabaseReference other)

Parameter
Name	Description
other	FirestoreDatabaseReference

Returns
Type	Description
FirestoreDatabaseReference.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FirestoreDatabaseReference.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FirestoreDatabaseReference.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FirestoreDatabaseReference.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FirestoreDatabaseReference.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

removeDatabaseTableReferences(int index)

public FirestoreDatabaseReference.Builder removeDatabaseTableReferences(int index)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
FirestoreDatabaseReference.Builder

setCollectionIds(int index, String value)

public FirestoreDatabaseReference.Builder setCollectionIds(int index, String value)

Optional. The collection ids. Denotes all collections if unset.

repeated string collection_ids = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int The index to set the value at.
value	String The collectionIds to set.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

setDatabaseId(String value)

public FirestoreDatabaseReference.Builder setDatabaseId(String value)

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The databaseId to set.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

setDatabaseIdBytes(ByteString value)

public FirestoreDatabaseReference.Builder setDatabaseIdBytes(ByteString value)

Required. The database id.

string database_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for databaseId to set.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

setDatabaseTableReferences(int index, DatabaseTableReference value)

public FirestoreDatabaseReference.Builder setDatabaseTableReferences(int index, DatabaseTableReference value)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DatabaseTableReference

Returns
Type	Description
FirestoreDatabaseReference.Builder

setDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

public FirestoreDatabaseReference.Builder setDatabaseTableReferences(int index, DatabaseTableReference.Builder builderForValue)

Optional. References to collections within the database. Each reference specifies a collection and can optionally include the collection's schema to provide context for the query.

repeated .google.cloud.geminidataanalytics.v1beta.DatabaseTableReference database_table_references = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DatabaseTableReference.Builder

Returns
Type	Description
FirestoreDatabaseReference.Builder

setProjectId(String value)

public FirestoreDatabaseReference.Builder setProjectId(String value)

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The projectId to set.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public FirestoreDatabaseReference.Builder setProjectIdBytes(ByteString value)

Required. Project the firestore database belongs to.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for projectId to set.

Returns
Type	Description
FirestoreDatabaseReference.Builder	This builder for chaining.