Interface MutationOrBuilder (2.25.1)

public interface MutationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBaseVersion()

public abstract 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;

Returns
Type Description
long

The baseVersion.

getConflictDetectionStrategyCase()

public abstract Mutation.ConflictDetectionStrategyCase getConflictDetectionStrategyCase()
Returns
Type Description
Mutation.ConflictDetectionStrategyCase

getConflictResolutionStrategy()

public abstract 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;

Returns
Type Description
Mutation.ConflictResolutionStrategy

The conflictResolutionStrategy.

getConflictResolutionStrategyValue()

public abstract 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;

Returns
Type Description
int

The enum numeric value on the wire for conflictResolutionStrategy.

getDelete()

public abstract 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;

Returns
Type Description
Key

The delete.

getDeleteOrBuilder()

public abstract 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;

Returns
Type Description
KeyOrBuilder

getInsert()

public abstract 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;

Returns
Type Description
Entity

The insert.

getInsertOrBuilder()

public abstract 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;

Returns
Type Description
EntityOrBuilder

getOperationCase()

public abstract Mutation.OperationCase getOperationCase()
Returns
Type Description
Mutation.OperationCase

getPropertyMask()

public abstract 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;

Returns
Type Description
PropertyMask

The propertyMask.

getPropertyMaskOrBuilder()

public abstract 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;

Returns
Type Description
PropertyMaskOrBuilder

getPropertyTransforms(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
PropertyTransform

getPropertyTransformsCount()

public abstract 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];

Returns
Type Description
int

getPropertyTransformsList()

public abstract 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];

Returns
Type Description
List<PropertyTransform>

getPropertyTransformsOrBuilder(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
PropertyTransformOrBuilder

getPropertyTransformsOrBuilderList()

public abstract 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];

Returns
Type Description
List<? extends com.google.datastore.v1.PropertyTransformOrBuilder>

getUpdate()

public abstract Entity getUpdate()

The entity to update. The entity must already exist. Must have a complete key path.

.google.datastore.v1.Entity update = 5;

Returns
Type Description
Entity

The update.

getUpdateOrBuilder()

public abstract EntityOrBuilder getUpdateOrBuilder()

The entity to update. The entity must already exist. Must have a complete key path.

.google.datastore.v1.Entity update = 5;

Returns
Type Description
EntityOrBuilder

getUpdateTime()

public abstract 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;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract 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;

Returns
Type Description
TimestampOrBuilder

getUpsert()

public abstract 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;

Returns
Type Description
Entity

The upsert.

getUpsertOrBuilder()

public abstract 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;

Returns
Type Description
EntityOrBuilder

hasBaseVersion()

public abstract 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;

Returns
Type Description
boolean

Whether the baseVersion field is set.

hasDelete()

public abstract 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;

Returns
Type Description
boolean

Whether the delete field is set.

hasInsert()

public abstract 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;

Returns
Type Description
boolean

Whether the insert field is set.

hasPropertyMask()

public abstract 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;

Returns
Type Description
boolean

Whether the propertyMask field is set.

hasUpdate()

public abstract boolean hasUpdate()

The entity to update. The entity must already exist. Must have a complete key path.

.google.datastore.v1.Entity update = 5;

Returns
Type Description
boolean

Whether the update field is set.

hasUpdateTime()

public abstract 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;

Returns
Type Description
boolean

Whether the updateTime field is set.

hasUpsert()

public abstract 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;

Returns
Type Description
boolean

Whether the upsert field is set.