Class CreateDocumentRequest.Builder (3.5.0)

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

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

build()

public CreateDocumentRequest build()
Returns
TypeDescription
CreateDocumentRequest

buildPartial()

public CreateDocumentRequest buildPartial()
Returns
TypeDescription
CreateDocumentRequest

clear()

public CreateDocumentRequest.Builder clear()
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
TypeDescription
CreateDocumentRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

clone()

public CreateDocumentRequest.Builder clone()
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for collectionId.

getDefaultInstanceForType()

public CreateDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the mask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueDocument
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeFrom(CreateDocumentRequest other)

public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)
Parameter
NameDescription
otherCreateDocumentRequest
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateDocumentRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
NameDescription
valueDocumentMask
Returns
TypeDescription
CreateDocumentRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
NameDescription
valueString

The collectionId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for collectionId to set.

Returns
TypeDescription
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
NameDescription
valueDocument
Returns
TypeDescription
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
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
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
NameDescription
valueString

The documentId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for documentId to set.

Returns
TypeDescription
CreateDocumentRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

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
NameDescription
valueDocumentMask
Returns
TypeDescription
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
NameDescription
builderForValueDocumentMask.Builder
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides