Interface CreateDocumentRequestOrBuilder (3.9.3)

public interface CreateDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionId()

public abstract 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 abstract 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.

getDocument()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasDocument()

public abstract 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 abstract 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.