public interface UpdateDocumentRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCurrentDocument()
public abstract Precondition getCurrentDocument()An optional precondition on the document. The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
| Returns | |
|---|---|
| Type | Description |
Precondition |
The currentDocument. |
getCurrentDocumentOrBuilder()
public abstract PreconditionOrBuilder getCurrentDocumentOrBuilder()An optional precondition on the document. The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
| Returns | |
|---|---|
| Type | Description |
PreconditionOrBuilder |
|
getDocument()
public abstract Document getDocument()Required. The updated document. Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Document |
The document. |
getDocumentOrBuilder()
public abstract DocumentOrBuilder getDocumentOrBuilder()Required. The updated document. Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.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 = 3;
| 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 = 3;
| Returns | |
|---|---|
| Type | Description |
DocumentMaskOrBuilder |
|
getUpdateMask()
public abstract DocumentMask getUpdateMask()The fields to update. None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
.google.firestore.v1.DocumentMask update_mask = 2;
| Returns | |
|---|---|
| Type | Description |
DocumentMask |
The updateMask. |
getUpdateMaskOrBuilder()
public abstract DocumentMaskOrBuilder getUpdateMaskOrBuilder()The fields to update. None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
.google.firestore.v1.DocumentMask update_mask = 2;
| Returns | |
|---|---|
| Type | Description |
DocumentMaskOrBuilder |
|
hasCurrentDocument()
public abstract boolean hasCurrentDocument()An optional precondition on the document. The request will fail if this is set and not met by the target document.
.google.firestore.v1.Precondition current_document = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the currentDocument field is set. |
hasDocument()
public abstract boolean hasDocument()Required. The updated document. Creates the document if it does not already exist.
.google.firestore.v1.Document document = 1 [(.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 = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mask field is set. |
hasUpdateMask()
public abstract boolean hasUpdateMask()The fields to update. None of the field paths in the mask may contain a reserved name.
If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.
.google.firestore.v1.DocumentMask update_mask = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateMask field is set. |