Class PropertyMask (2.20.1)

public final class PropertyMask extends GeneratedMessageV3 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 Fields

PATHS_FIELD_NUMBER

public static final int PATHS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PropertyMask getDefaultInstance()
Returns
Type Description
PropertyMask

getDescriptor()

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

newBuilder()

public static PropertyMask.Builder newBuilder()
Returns
Type Description
PropertyMask.Builder

newBuilder(PropertyMask prototype)

public static PropertyMask.Builder newBuilder(PropertyMask prototype)
Parameter
Name Description
prototype PropertyMask
Returns
Type Description
PropertyMask.Builder

parseDelimitedFrom(InputStream input)

public static PropertyMask parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PropertyMask parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PropertyMask parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PropertyMask parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PropertyMask parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PropertyMask parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PropertyMask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PropertyMask
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PropertyMask> parser()
Returns
Type Description
Parser<PropertyMask>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PropertyMask getDefaultInstanceForType()
Returns
Type Description
PropertyMask

getParserForType()

public Parser<PropertyMask> getParserForType()
Returns
Type Description
Parser<PropertyMask>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PropertyMask.Builder newBuilderForType()
Returns
Type Description
PropertyMask.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PropertyMask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PropertyMask.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PropertyMask.Builder toBuilder()
Returns
Type Description
PropertyMask.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException