com.google.firestore.v1

Interface CreateDocumentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CreateDocumentRequest, CreateDocumentRequest.Builder

public interface CreateDocumentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCollectionId() Required.
com.google.protobuf.ByteString	getCollectionIdBytes() Required.
Document	getDocument() Required.
String	getDocumentId() The client-assigned document ID to use for this document.
com.google.protobuf.ByteString	getDocumentIdBytes() The client-assigned document ID to use for this document.
DocumentOrBuilder	getDocumentOrBuilder() Required.
DocumentMask	getMask() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
boolean	hasDocument() Required.
boolean	hasMask() The fields to return.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

getCollectionId

String getCollectionId()

 Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
 

string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The collectionId.

getCollectionIdBytes

com.google.protobuf.ByteString getCollectionIdBytes()

 Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
 

string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for collectionId.

getDocumentId

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:

The documentId.

getDocumentIdBytes

com.google.protobuf.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:

The bytes for documentId.

hasDocument

boolean hasDocument()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the document field is set.

getDocument

Document getDocument()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The document.

getDocumentOrBuilder

DocumentOrBuilder getDocumentOrBuilder()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

hasMask

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:

Whether the mask field is set.

getMask

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:

The mask.

getMaskOrBuilder

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;