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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PATHS_FIELD_NUMBER
public static final int PATHS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PropertyMask getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PropertyMask.Builder newBuilder()
newBuilder(PropertyMask prototype)
public static PropertyMask.Builder newBuilder(PropertyMask prototype)
public static PropertyMask parseDelimitedFrom(InputStream input)
public static PropertyMask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PropertyMask parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PropertyMask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PropertyMask parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyMask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PropertyMask parseFrom(CodedInputStream input)
public static PropertyMask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PropertyMask parseFrom(InputStream input)
public static PropertyMask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PropertyMask parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PropertyMask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PropertyMask> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public PropertyMask getDefaultInstanceForType()
getParserForType()
public Parser<PropertyMask> getParserForType()
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;
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PropertyMask.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PropertyMask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public PropertyMask.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides