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.GeneratedMessageV3.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.GeneratedMessageV3.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 Details

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

    • clone

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

    • setField

      public PropertyMask.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>

    • clearField

      public PropertyMask.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>

    • clearOneof

      public PropertyMask.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>

    • setRepeatedField

      public PropertyMask.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>

    • addRepeatedField

      public PropertyMask.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.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.GeneratedMessageV3.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.

    • setUnknownFields

      public final PropertyMask.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>

    • mergeUnknownFields

      public final PropertyMask.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PropertyMask.Builder>