Class PropertyMask.Builder (2.20.2)

Version 2.20.2

• 2.23.0 (latest)
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PropertyMask.Builder

Implements

PropertyMaskOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public PropertyMask.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
PropertyMask.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public PropertyMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
PropertyMask.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public PropertyMask getDefaultInstanceForType()

Returns
Type	Description
PropertyMask

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PropertyMask.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PropertyMask.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PropertyMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PropertyMask.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PropertyMask.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PropertyMask.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)