Class PropertyMask.Builder (2.20.1)

public static final class PropertyMask.Builder extends GeneratedMessageV3.Builder<PropertyMask.Builder> implements PropertyMaskOrBuilder

The 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPaths(Iterable<String> values)

public PropertyMask.Builder addAllPaths(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)

public PropertyMask.Builder addPaths(String value)

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)

public PropertyMask.Builder addPathsBytes(ByteString value)

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)

public PropertyMask.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyMask.Builder
Overrides

build()

public PropertyMask build()
Returns
Type Description
PropertyMask

buildPartial()

public PropertyMask buildPartial()
Returns
Type Description
PropertyMask

clear()

public PropertyMask.Builder clear()
Returns
Type Description
PropertyMask.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PropertyMask.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PropertyMask.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PropertyMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PropertyMask.Builder
Overrides

clearPaths()

public PropertyMask.Builder clearPaths()

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()

public PropertyMask.Builder clone()
Returns
Type Description
PropertyMask.Builder
Overrides

getDefaultInstanceForType()

public PropertyMask getDefaultInstanceForType()
Returns
Type Description
PropertyMask

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPaths(int index)

public String getPaths(int index)

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)

public ByteString getPathsBytes(int index)

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()

public int getPathsCount()

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()

public ProtocolStringList getPathsList()

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()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PropertyMask other)

public PropertyMask.Builder mergeFrom(PropertyMask other)
Parameter
Name Description
other PropertyMask
Returns
Type Description
PropertyMask.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PropertyMask.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PropertyMask.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PropertyMask.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PropertyMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyMask.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PropertyMask.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PropertyMask.Builder
Overrides

setPaths(int index, String value)

public PropertyMask.Builder setPaths(int index, String value)

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)

public PropertyMask.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PropertyMask.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PropertyMask.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PropertyMask.Builder
Overrides