Package com.google.datastore.v1

Class Mutation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.Mutation
All Implemented Interfaces:
MutationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Mutation extends com.google.protobuf.GeneratedMessageV3 implements MutationOrBuilder
 A mutation to apply to an entity.
Protobuf type google.datastore.v1.Mutation
See Also:

  • Field Details

    • INSERT_FIELD_NUMBER

      public static final int INSERT_FIELD_NUMBER
      See Also:

    • UPDATE_FIELD_NUMBER

      public static final int UPDATE_FIELD_NUMBER
      See Also:

    • UPSERT_FIELD_NUMBER

      public static final int UPSERT_FIELD_NUMBER
      See Also:

    • DELETE_FIELD_NUMBER

      public static final int DELETE_FIELD_NUMBER
      See Also:

    • BASE_VERSION_FIELD_NUMBER

      public static final int BASE_VERSION_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • CONFLICT_RESOLUTION_STRATEGY_FIELD_NUMBER

      public static final int CONFLICT_RESOLUTION_STRATEGY_FIELD_NUMBER
      See Also:

    • PROPERTY_MASK_FIELD_NUMBER

      public static final int PROPERTY_MASK_FIELD_NUMBER
      See Also:

    • PROPERTY_TRANSFORMS_FIELD_NUMBER

      public static final int PROPERTY_TRANSFORMS_FIELD_NUMBER
      See Also:

  • 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

    • getOperationCase

      public Mutation.OperationCase getOperationCase()
      Specified by:
      getOperationCase in interface MutationOrBuilder

    • getConflictDetectionStrategyCase

      public Mutation.ConflictDetectionStrategyCase getConflictDetectionStrategyCase()
      Specified by:
      getConflictDetectionStrategyCase in interface MutationOrBuilder

    • hasInsert

      public boolean hasInsert()
       The entity to insert. The entity must not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity insert = 4;
      Specified by:
      hasInsert in interface MutationOrBuilder
      Returns:
      Whether the insert field is set.

    • getInsert

      public Entity getInsert()
       The entity to insert. The entity must not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity insert = 4;
      Specified by:
      getInsert in interface MutationOrBuilder
      Returns:
      The insert.

    • getInsertOrBuilder

      public EntityOrBuilder getInsertOrBuilder()
       The entity to insert. The entity must not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity insert = 4;
      Specified by:
      getInsertOrBuilder in interface MutationOrBuilder

    • hasUpdate

      public boolean hasUpdate()
       The entity to update. The entity must already exist.
 Must have a complete key path.
      .google.datastore.v1.Entity update = 5;
      Specified by:
      hasUpdate in interface MutationOrBuilder
      Returns:
      Whether the update field is set.

    • getUpdate

      public Entity getUpdate()
       The entity to update. The entity must already exist.
 Must have a complete key path.
      .google.datastore.v1.Entity update = 5;
      Specified by:
      getUpdate in interface MutationOrBuilder
      Returns:
      The update.

    • getUpdateOrBuilder

      public EntityOrBuilder getUpdateOrBuilder()
       The entity to update. The entity must already exist.
 Must have a complete key path.
      .google.datastore.v1.Entity update = 5;
      Specified by:
      getUpdateOrBuilder in interface MutationOrBuilder

    • hasUpsert

      public boolean hasUpsert()
       The entity to upsert. The entity may or may not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity upsert = 6;
      Specified by:
      hasUpsert in interface MutationOrBuilder
      Returns:
      Whether the upsert field is set.

    • getUpsert

      public Entity getUpsert()
       The entity to upsert. The entity may or may not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity upsert = 6;
      Specified by:
      getUpsert in interface MutationOrBuilder
      Returns:
      The upsert.

    • getUpsertOrBuilder

      public EntityOrBuilder getUpsertOrBuilder()
       The entity to upsert. The entity may or may not already exist.
 The entity key's final path element may be incomplete.
      .google.datastore.v1.Entity upsert = 6;
      Specified by:
      getUpsertOrBuilder in interface MutationOrBuilder

    • hasDelete

      public boolean hasDelete()
       The key of the entity to delete. The entity may or may not already exist.
 Must have a complete key path and must not be reserved/read-only.
      .google.datastore.v1.Key delete = 7;
      Specified by:
      hasDelete in interface MutationOrBuilder
      Returns:
      Whether the delete field is set.

    • getDelete

      public Key getDelete()
       The key of the entity to delete. The entity may or may not already exist.
 Must have a complete key path and must not be reserved/read-only.
      .google.datastore.v1.Key delete = 7;
      Specified by:
      getDelete in interface MutationOrBuilder
      Returns:
      The delete.

    • getDeleteOrBuilder

      public KeyOrBuilder getDeleteOrBuilder()
       The key of the entity to delete. The entity may or may not already exist.
 Must have a complete key path and must not be reserved/read-only.
      .google.datastore.v1.Key delete = 7;
      Specified by:
      getDeleteOrBuilder in interface MutationOrBuilder

    • hasBaseVersion

      public boolean hasBaseVersion()
       The version of the entity that this mutation is being applied
 to. If this does not match the current version on the server, the
 mutation conflicts.
      int64 base_version = 8;
      Specified by:
      hasBaseVersion in interface MutationOrBuilder
      Returns:
      Whether the baseVersion field is set.

    • getBaseVersion

      public long getBaseVersion()
       The version of the entity that this mutation is being applied
 to. If this does not match the current version on the server, the
 mutation conflicts.
      int64 base_version = 8;
      Specified by:
      getBaseVersion in interface MutationOrBuilder
      Returns:
      The baseVersion.

    • hasUpdateTime

      public boolean hasUpdateTime()
       The update time of the entity that this mutation is being applied
 to. If this does not match the current update time on the server, the
 mutation conflicts.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      hasUpdateTime in interface MutationOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       The update time of the entity that this mutation is being applied
 to. If this does not match the current update time on the server, the
 mutation conflicts.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      getUpdateTime in interface MutationOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       The update time of the entity that this mutation is being applied
 to. If this does not match the current update time on the server, the
 mutation conflicts.
      .google.protobuf.Timestamp update_time = 11;
      Specified by:
      getUpdateTimeOrBuilder in interface MutationOrBuilder

    • getConflictResolutionStrategyValue

      public int getConflictResolutionStrategyValue()
       The strategy to use when a conflict is detected. Defaults to
 `SERVER_VALUE`.
 If this is set, then `conflict_detection_strategy` must also be set.
      .google.datastore.v1.Mutation.ConflictResolutionStrategy conflict_resolution_strategy = 10;
      Specified by:
      getConflictResolutionStrategyValue in interface MutationOrBuilder
      Returns:
      The enum numeric value on the wire for conflictResolutionStrategy.

    • getConflictResolutionStrategy

      public Mutation.ConflictResolutionStrategy getConflictResolutionStrategy()
       The strategy to use when a conflict is detected. Defaults to
 `SERVER_VALUE`.
 If this is set, then `conflict_detection_strategy` must also be set.
      .google.datastore.v1.Mutation.ConflictResolutionStrategy conflict_resolution_strategy = 10;
      Specified by:
      getConflictResolutionStrategy in interface MutationOrBuilder
      Returns:
      The conflictResolutionStrategy.

    • hasPropertyMask

      public boolean hasPropertyMask()
       The properties to write in this mutation.
 None of the properties in the mask may have a reserved name, except for
 `__key__`.
 This field is ignored for `delete`.

 If the entity already exists, only properties referenced in the mask are
 updated, others are left untouched.
 Properties referenced in the mask but not in the entity are deleted.
      .google.datastore.v1.PropertyMask property_mask = 9;
      Specified by:
      hasPropertyMask in interface MutationOrBuilder
      Returns:
      Whether the propertyMask field is set.

    • getPropertyMask

      public PropertyMask getPropertyMask()
       The properties to write in this mutation.
 None of the properties in the mask may have a reserved name, except for
 `__key__`.
 This field is ignored for `delete`.

 If the entity already exists, only properties referenced in the mask are
 updated, others are left untouched.
 Properties referenced in the mask but not in the entity are deleted.
      .google.datastore.v1.PropertyMask property_mask = 9;
      Specified by:
      getPropertyMask in interface MutationOrBuilder
      Returns:
      The propertyMask.

    • getPropertyMaskOrBuilder

      public PropertyMaskOrBuilder getPropertyMaskOrBuilder()
       The properties to write in this mutation.
 None of the properties in the mask may have a reserved name, except for
 `__key__`.
 This field is ignored for `delete`.

 If the entity already exists, only properties referenced in the mask are
 updated, others are left untouched.
 Properties referenced in the mask but not in the entity are deleted.
      .google.datastore.v1.PropertyMask property_mask = 9;
      Specified by:
      getPropertyMaskOrBuilder in interface MutationOrBuilder

    • getPropertyTransformsList

      public List<PropertyTransform> getPropertyTransformsList()
       Optional. The transforms to perform on the entity.

 This field can be set only when the operation is `insert`, `update`,
 or `upsert`. If present, the transforms are be applied to the entity
 regardless of the property mask, in order, after the operation.
      repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyTransformsList in interface MutationOrBuilder

    • getPropertyTransformsOrBuilderList

      public List<? extends PropertyTransformOrBuilder> getPropertyTransformsOrBuilderList()
       Optional. The transforms to perform on the entity.

 This field can be set only when the operation is `insert`, `update`,
 or `upsert`. If present, the transforms are be applied to the entity
 regardless of the property mask, in order, after the operation.
      repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyTransformsOrBuilderList in interface MutationOrBuilder

    • getPropertyTransformsCount

      public int getPropertyTransformsCount()
       Optional. The transforms to perform on the entity.

 This field can be set only when the operation is `insert`, `update`,
 or `upsert`. If present, the transforms are be applied to the entity
 regardless of the property mask, in order, after the operation.
      repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyTransformsCount in interface MutationOrBuilder

    • getPropertyTransforms

      public PropertyTransform getPropertyTransforms(int index)
       Optional. The transforms to perform on the entity.

 This field can be set only when the operation is `insert`, `update`,
 or `upsert`. If present, the transforms are be applied to the entity
 regardless of the property mask, in order, after the operation.
      repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyTransforms in interface MutationOrBuilder

    • getPropertyTransformsOrBuilder

      public PropertyTransformOrBuilder getPropertyTransformsOrBuilder(int index)
       Optional. The transforms to perform on the entity.

 This field can be set only when the operation is `insert`, `update`,
 or `upsert`. If present, the transforms are be applied to the entity
 regardless of the property mask, in order, after the operation.
      repeated .google.datastore.v1.PropertyTransform property_transforms = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPropertyTransformsOrBuilder in interface MutationOrBuilder

    • 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 Mutation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Mutation.Builder newBuilder()

    • newBuilder

      public static Mutation.Builder newBuilder(Mutation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Mutation getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Mutation> 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 Mutation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder