public static final class CreateDocumentRequest.Builder extends GeneratedMessageV3.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilderThe request for Firestore.CreateDocument.
Protobuf type google.firestore.v1.CreateDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateDocumentRequest.BuilderImplements
CreateDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CreateDocumentRequest.Builder |
build()
public CreateDocumentRequest build()| Type | Description |
| CreateDocumentRequest |
buildPartial()
public CreateDocumentRequest buildPartial()| Type | Description |
| CreateDocumentRequest |
clear()
public CreateDocumentRequest.Builder clear()| Type | Description |
| CreateDocumentRequest.Builder |
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];
| 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];
| 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;
| Type | Description |
| CreateDocumentRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| CreateDocumentRequest.Builder |
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;
| Type | Description |
| CreateDocumentRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| CreateDocumentRequest.Builder |
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];
| Type | Description |
| CreateDocumentRequest.Builder | This builder for chaining. |
clone()
public CreateDocumentRequest.Builder clone()| Type | Description |
| CreateDocumentRequest.Builder |
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];
| 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];
| Type | Description |
| ByteString | The bytes for collectionId. |
getDefaultInstanceForType()
public CreateDocumentRequest getDefaultInstanceForType()| Type | Description |
| CreateDocumentRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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];
| 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];
| 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;
| 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;
| 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];
| 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;
| 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;
| 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;
| 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];
| 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];
| 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];
| 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;
| Type | Description |
| boolean | Whether the mask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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];
| Name | Description |
| value | Document |
| Type | Description |
| CreateDocumentRequest.Builder |
mergeFrom(CreateDocumentRequest other)
public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)| Name | Description |
| other | CreateDocumentRequest |
| Type | Description |
| CreateDocumentRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| CreateDocumentRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public CreateDocumentRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| CreateDocumentRequest.Builder |
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;
| Name | Description |
| value | DocumentMask |
| Type | Description |
| CreateDocumentRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CreateDocumentRequest.Builder |
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];
| Name | Description |
| value | StringThe collectionId to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for collectionId to set. |
| 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];
| Name | Description |
| value | Document |
| 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];
| Name | Description |
| builderForValue | Document.Builder |
| 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;
| Name | Description |
| value | StringThe documentId to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for documentId to set. |
| Type | Description |
| CreateDocumentRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| CreateDocumentRequest.Builder |
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;
| Name | Description |
| value | DocumentMask |
| 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;
| Name | Description |
| builderForValue | DocumentMask.Builder |
| 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];
| Name | Description |
| value | StringThe parent to set. |
| 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];
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| CreateDocumentRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| CreateDocumentRequest.Builder |