Package com.google.datastore.v1

Class PropertyMask

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.PropertyMask
All Implemented Interfaces:
PropertyMaskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class PropertyMask extends com.google.protobuf.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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PropertyMask.Builder
    The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PATHS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static PropertyMask
    getDefaultInstance()
     
    PropertyMask
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<PropertyMask>
    getParserForType()
     
    String
    getPaths(int index)
    The paths to the properties covered by this mask.
    com.google.protobuf.ByteString
    getPathsBytes(int index)
    The paths to the properties covered by this mask.
    int
    getPathsCount()
    The paths to the properties covered by this mask.
    com.google.protobuf.ProtocolStringList
    getPathsList()
    The paths to the properties covered by this mask.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PropertyMask.Builder
    newBuilder()
     
    static PropertyMask.Builder
    newBuilder(PropertyMask prototype)
     
    PropertyMask.Builder
    newBuilderForType()
     
    protected PropertyMask.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PropertyMask
    parseDelimitedFrom(InputStream input)
     
    static PropertyMask
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PropertyMask
    parseFrom(byte[] data)
     
    static PropertyMask
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PropertyMask
    parseFrom(com.google.protobuf.ByteString data)
     
    static PropertyMask
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PropertyMask
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PropertyMask
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PropertyMask
    parseFrom(InputStream input)
     
    static PropertyMask
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PropertyMask
    parseFrom(ByteBuffer data)
     
    static PropertyMask
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PropertyMask>
    parser()
     
    PropertyMask.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getPathsList

      public com.google.protobuf.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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Specified by:
      getPathsList in interface PropertyMaskOrBuilder
      Returns:
      A list containing the paths.

    • 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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Specified by:
      getPathsCount in interface PropertyMaskOrBuilder
      Returns:
      The count of paths.

    • getPaths

      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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Specified by:
      getPaths in interface PropertyMaskOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The paths at the given index.

    • getPathsBytes

      public com.google.protobuf.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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Specified by:
      getPathsBytes in interface PropertyMaskOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the paths at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PropertyMask parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PropertyMask parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyMask parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PropertyMask parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PropertyMask parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyMask parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PropertyMask parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PropertyMask.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PropertyMask.Builder newBuilder()

    • newBuilder

      public static PropertyMask.Builder newBuilder(PropertyMask prototype)

    • toBuilder

      public PropertyMask.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PropertyMask.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static PropertyMask getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PropertyMask> parser()

    • getParserForType

      public com.google.protobuf.Parser<PropertyMask> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public PropertyMask getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder