public static final class DocumentMask.Builder extends GeneratedMessageV3.Builder<DocumentMask.Builder> implements DocumentMaskOrBuilderA set of field paths on a document.
Protobuf type google.events.cloud.firestore.v1.DocumentMask
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentMask.BuilderImplements
DocumentMaskOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllFieldPaths(Iterable<String> values)
public DocumentMask.Builder addAllFieldPaths(Iterable<String> values)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | This builder for chaining. |
addFieldPaths(String value)
public DocumentMask.Builder addFieldPaths(String value)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | This builder for chaining. |
addFieldPathsBytes(ByteString value)
public DocumentMask.Builder addFieldPathsBytes(ByteString value)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the fieldPaths to add. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
build()
public DocumentMask build()| Returns | |
|---|---|
| Type | Description |
DocumentMask | |
buildPartial()
public DocumentMask buildPartial()| Returns | |
|---|---|
| Type | Description |
DocumentMask | |
clear()
public DocumentMask.Builder clear()| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
clearField(Descriptors.FieldDescriptor field)
public DocumentMask.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
clearFieldPaths()
public DocumentMask.Builder clearFieldPaths()The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DocumentMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
clone()
public DocumentMask.Builder clone()| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DocumentMask | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getFieldPaths(int index)
public String getFieldPaths(int index)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The fieldPaths at the given index. |
getFieldPathsBytes(int index)
public ByteString getFieldPathsBytes(int index)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the fieldPaths at the given index. |
getFieldPathsCount()
public int getFieldPathsCount()The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Returns | |
|---|---|
| Type | Description |
int | The count of fieldPaths. |
getFieldPathsList()
public ProtocolStringList getFieldPathsList()The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the fieldPaths. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(DocumentMask other)
public DocumentMask.Builder mergeFrom(DocumentMask other)| Parameter | |
|---|---|
| Name | Description |
other | DocumentMask |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DocumentMask.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public DocumentMask.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public DocumentMask.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
setFieldPaths(int index, String value)
public DocumentMask.Builder setFieldPaths(int index, String value)The list of field paths in the mask. See Document.fields for a field path syntax reference.
repeated string field_paths = 1;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe fieldPaths to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DocumentMask.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentMask.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentMask.Builder | |