Class PropertyMask.Builder (2.27.1)
Stay organized with collections
Save and categorize content based on your preferences.
publicstaticfinalclass PropertyMask.BuilderextendsGeneratedMessageV3.Builder<PropertyMask.Builder>implementsPropertyMaskOrBuilderThe set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.
Protobuf type google.datastore.v1.PropertyMask
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PropertyMask.BuilderImplements
PropertyMaskOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllPaths(Iterable<String> values)
publicPropertyMask.BuilderaddAllPaths(Iterable<String>values)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The paths to add. |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
This builder for chaining. |
addPaths(String value)
publicPropertyMask.BuilderaddPaths(Stringvalue)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
String The paths to add. |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
This builder for chaining. |
addPathsBytes(ByteString value)
publicPropertyMask.BuilderaddPathsBytes(ByteStringvalue)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes of the paths to add. |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicPropertyMask.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
build()
publicPropertyMaskbuild()| Returns | |
|---|---|
| Type | Description |
PropertyMask |
|
buildPartial()
publicPropertyMaskbuildPartial()| Returns | |
|---|---|
| Type | Description |
PropertyMask |
|
clear()
publicPropertyMask.Builderclear()| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicPropertyMask.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
publicPropertyMask.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
clearPaths()
publicPropertyMask.BuilderclearPaths()The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
This builder for chaining. |
clone()
publicPropertyMask.Builderclone()| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
getDefaultInstanceForType()
publicPropertyMaskgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PropertyMask |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getPaths(int index)
publicStringgetPaths(intindex)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The paths at the given index. |
getPathsBytes(int index)
publicByteStringgetPathsBytes(intindex)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the paths at the given index. |
getPathsCount()
publicintgetPathsCount()The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The count of paths. |
getPathsList()
publicProtocolStringListgetPathsList()The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the paths. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PropertyMask other)
publicPropertyMask.BuildermergeFrom(PropertyMaskother)| Parameter | |
|---|---|
| Name | Description |
other |
PropertyMask |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicPropertyMask.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicPropertyMask.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalPropertyMask.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicPropertyMask.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
setPaths(int index, String value)
publicPropertyMask.BuildersetPaths(intindex,Stringvalue)The paths to the properties covered by this mask.
A path is a list of property names separated by dots (.), for example
foo.bar means the property bar inside the entity property foo inside
the entity associated with this path.
If a property name contains a dot . or a backslash \, then that
name must be escaped.
A path must not be empty, and may not reference a value inside an array value.
repeated string paths = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int The index to set the value at. |
value |
String The paths to set. |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicPropertyMask.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalPropertyMask.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PropertyMask.Builder |
|