Class CreateDocumentRequest (3.21.1)

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
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()
Returns
Type Description
CreateDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateDocumentRequest.Builder newBuilder()
Returns
Type Description
CreateDocumentRequest.Builder

newBuilder(CreateDocumentRequest prototype)

public static CreateDocumentRequest.Builder newBuilder(CreateDocumentRequest prototype)
Parameter
Name Description
prototype CreateDocumentRequest
Returns
Type Description
CreateDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateDocumentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDocumentRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDocumentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateDocumentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateDocumentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateDocumentRequest> parser()
Returns
Type Description
Parser<CreateDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
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

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];

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.

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.

getParserForType()

public Parser<CreateDocumentRequest> getParserForType()
Returns
Type Description
Parser<CreateDocumentRequest>
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()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateDocumentRequest.Builder newBuilderForType()
Returns
Type Description
CreateDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateDocumentRequest.Builder toBuilder()
Returns
Type Description
CreateDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException