Send feedback
Class CreateDocumentRequest (3.15.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.15.1 keyboard_arrow_down
public final class CreateDocumentRequest extends GeneratedMessageV3 implements CreateDocumentRequestOrBuilder
The request for
Firestore.CreateDocument .
Protobuf type google.firestore.v1.CreateDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
COLLECTION_ID_FIELD_NUMBER
public static final int COLLECTION_ID_FIELD_NUMBER
Field Value Type Description int
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value Type Description int
DOCUMENT_ID_FIELD_NUMBER
public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value Type Description int
MASK_FIELD_NUMBER
public static final int MASK_FIELD_NUMBER
Field Value Type Description int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static CreateDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CreateDocumentRequest . Builder newBuilder ()
newBuilder(CreateDocumentRequest prototype)
public static CreateDocumentRequest . Builder newBuilder ( CreateDocumentRequest prototype )
public static CreateDocumentRequest parseDelimitedFrom ( InputStream input )
public static CreateDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CreateDocumentRequest parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CreateDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CreateDocumentRequest parseFrom ( CodedInputStream input )
public static CreateDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CreateDocumentRequest parseFrom ( InputStream input )
public static CreateDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CreateDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CreateDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
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 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 ()
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.
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];
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;
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;
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.
getParserForType()
public Parser<CreateDocumentRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
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()
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.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CreateDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public CreateDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
