Package com.google.datastore.v1

Class PropertyMask.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PropertyMask.Builder>
com.google.datastore.v1.PropertyMask.Builder
All Implemented Interfaces:
PropertyMaskOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PropertyMask
public static final class PropertyMask.Builder extends com.google.protobuf.GeneratedMessage.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

  • Method Summary

    Modifier and Type
    Method
    Description
    PropertyMask.Builder
    addAllPaths(Iterable<String> values)
    The paths to the properties covered by this mask.
    PropertyMask.Builder
    addPaths(String value)
    The paths to the properties covered by this mask.
    PropertyMask.Builder
    addPathsBytes(com.google.protobuf.ByteString value)
    The paths to the properties covered by this mask.
    PropertyMask
    build()
     
    PropertyMask
    buildPartial()
     
    PropertyMask.Builder
    clear()
     
    PropertyMask.Builder
    clearPaths()
    The paths to the properties covered by this mask.
    PropertyMask
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    PropertyMask.Builder
    mergeFrom(PropertyMask other)
     
    PropertyMask.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    PropertyMask.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    PropertyMask.Builder
    setPaths(int index, String value)
    The paths to the properties covered by this mask.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PropertyMask.Builder>

    • clear

      public PropertyMask.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<PropertyMask.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PropertyMask.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public PropertyMask.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PropertyMask.Builder>

    • mergeFrom

      public PropertyMask.Builder mergeFrom(PropertyMask other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PropertyMask.Builder>

    • mergeFrom

      public PropertyMask.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PropertyMask.Builder>
      Throws:
      IOException

    • 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.

    • setPaths

      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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Parameters:
      index - The index to set the value at.
      value - The paths to set.
      Returns:
      This builder for chaining.

    • addPaths

      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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Parameters:
      value - The paths to add.
      Returns:
      This builder for chaining.

    • addAllPaths

      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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Parameters:
      values - The paths to add.
      Returns:
      This builder for chaining.

    • 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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Returns:
      This builder for chaining.

    • addPathsBytes

      public PropertyMask.Builder addPathsBytes(com.google.protobuf.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][google.datastore.v1.Value.array_value].
      repeated string paths = 1;
      Parameters:
      value - The bytes of the paths to add.
      Returns:
      This builder for chaining.