Package com.google.datastore.v1

Interface PropertyMaskOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PropertyMask, PropertyMask.Builder
public interface PropertyMaskOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    List<String>
    getPathsList()
    The paths to the properties covered by this mask.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPathsList

      List<String> 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;
      Returns:
      A list containing the paths.

    • getPathsCount

      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;
      Returns:
      The count of paths.

    • getPaths

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The paths at the given index.

    • getPathsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the paths at the given index.