Class CreateDocumentRequest (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public final class CreateDocumentRequest extends GeneratedMessageV3 implements CreateDocumentRequestOrBuilder

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

Static Fields

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

MASK_FIELD_NUMBER

public static final int MASK_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateDocumentRequest getDefaultInstance()
Returns
TypeDescription
CreateDocumentRequest

getDescriptor()

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

newBuilder()

public static CreateDocumentRequest.Builder newBuilder()
Returns
TypeDescription
CreateDocumentRequest.Builder

newBuilder(CreateDocumentRequest prototype)

public static CreateDocumentRequest.Builder newBuilder(CreateDocumentRequest prototype)
Parameter
NameDescription
prototypeCreateDocumentRequest
Returns
TypeDescription
CreateDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateDocumentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDocumentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDocumentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateDocumentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateDocumentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateDocumentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateDocumentRequest> parser()
Returns
TypeDescription
Parser<CreateDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

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.

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.

getParserForType()

public Parser<CreateDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<CreateDocumentRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateDocumentRequest.Builder toBuilder()
Returns
TypeDescription
CreateDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException