Class CreateDocumentRequest.Builder (3.4.2)

Version 3.4.2

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class CreateDocumentRequest.Builder extends GeneratedMessageV3.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilder

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateDocumentRequest.Builder

Implements

CreateDocumentRequestOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CreateDocumentRequest build()

Returns

Type	Description
CreateDocumentRequest

buildPartial()

public CreateDocumentRequest buildPartial()

Returns

Type	Description
CreateDocumentRequest

clear()

public CreateDocumentRequest.Builder clear()

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCollectionId()

public CreateDocumentRequest.Builder clearCollectionId()

Required. The collection ID, relative to parent, to list. For example: chatrooms.

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

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

clearDocument()

public CreateDocumentRequest.Builder clearDocument()

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
CreateDocumentRequest.Builder

clearDocumentId()

public CreateDocumentRequest.Builder clearDocumentId()

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

string document_id = 3;

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMask()

public CreateDocumentRequest.Builder clearMask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Returns

Type	Description
CreateDocumentRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParent()

public CreateDocumentRequest.Builder clearParent()

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

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

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

clone()

public CreateDocumentRequest.Builder clone()

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCollectionId()

public String getCollectionId()

Required. The collection ID, relative to parent, to list. For example: chatrooms.

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

Returns

Type	Description
String	The collectionId.

getCollectionIdBytes()

public ByteString getCollectionIdBytes()

Required. The collection ID, relative to parent, to list. For example: chatrooms.

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

Returns

Type	Description
ByteString	The bytes for collectionId.

getDefaultInstanceForType()

public CreateDocumentRequest getDefaultInstanceForType()

Returns

Type	Description
CreateDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocument()

public Document getDocument()

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Document	The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Document.Builder

getDocumentId()

public String getDocumentId()

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

string document_id = 3;

Returns

Type	Description
String	The documentId.

getDocumentIdBytes()

public ByteString getDocumentIdBytes()

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

string document_id = 3;

Returns

Type	Description
ByteString	The bytes for documentId.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
DocumentOrBuilder

getMask()

public DocumentMask getMask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Returns

Type	Description
DocumentMask	The mask.

getMaskBuilder()

public DocumentMask.Builder getMaskBuilder()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Returns

Type	Description
DocumentMask.Builder

getMaskOrBuilder()

public DocumentMaskOrBuilder getMaskOrBuilder()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Returns

Type	Description
DocumentMaskOrBuilder

getParent()

public String getParent()

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

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

Returns

Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

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

Returns

Type	Description
ByteString	The bytes for parent.

hasDocument()

public boolean hasDocument()

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the document field is set.

hasMask()

public boolean hasMask()

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Returns

Type	Description
boolean	Whether the mask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDocument(Document value)

public CreateDocumentRequest.Builder mergeDocument(Document value)

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Document

Returns

Type	Description
CreateDocumentRequest.Builder

mergeFrom(CreateDocumentRequest other)

public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)

Parameter

Name	Description
other	CreateDocumentRequest

Returns

Type	Description
CreateDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public CreateDocumentRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

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

mergeMask(DocumentMask value)

public CreateDocumentRequest.Builder mergeMask(DocumentMask value)

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Parameter

Name	Description
value	DocumentMask

Returns

Type	Description
CreateDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCollectionId(String value)

public CreateDocumentRequest.Builder setCollectionId(String value)

Required. The collection ID, relative to parent, to list. For example: chatrooms.

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

Parameter

Name	Description
value	String The collectionId to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setCollectionIdBytes(ByteString value)

public CreateDocumentRequest.Builder setCollectionIdBytes(ByteString value)

Required. The collection ID, relative to parent, to list. For example: chatrooms.

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

Parameter

Name	Description
value	ByteString The bytes for collectionId to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setDocument(Document value)

public CreateDocumentRequest.Builder setDocument(Document value)

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	Document

Returns

Type	Description
CreateDocumentRequest.Builder

setDocument(Document.Builder builderForValue)

public CreateDocumentRequest.Builder setDocument(Document.Builder builderForValue)

Required. The document to create. name must not be set.

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	Document.Builder

Returns

Type	Description
CreateDocumentRequest.Builder

setDocumentId(String value)

public CreateDocumentRequest.Builder setDocumentId(String value)

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

string document_id = 3;

Parameter

Name	Description
value	String The documentId to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setDocumentIdBytes(ByteString value)

public CreateDocumentRequest.Builder setDocumentIdBytes(ByteString value)

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

string document_id = 3;

Parameter

Name	Description
value	ByteString The bytes for documentId to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMask(DocumentMask value)

public CreateDocumentRequest.Builder setMask(DocumentMask value)

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Parameter

Name	Description
value	DocumentMask

Returns

Type	Description
CreateDocumentRequest.Builder

setMask(DocumentMask.Builder builderForValue)

public CreateDocumentRequest.Builder setMask(DocumentMask.Builder builderForValue)

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

.google.firestore.v1.DocumentMask mask = 5;

Parameter

Name	Description
builderForValue	DocumentMask.Builder

Returns

Type	Description
CreateDocumentRequest.Builder

setParent(String value)

public CreateDocumentRequest.Builder setParent(String value)

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

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

Parameter

Name	Description
value	String The parent to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public CreateDocumentRequest.Builder setParentBytes(ByteString value)

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

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

Parameter

Name	Description
value	ByteString The bytes for parent to set.

Returns

Type	Description
CreateDocumentRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CreateDocumentRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)