Class Mutation.Builder (2.20.0)

public static final class Mutation.Builder extends GeneratedMessageV3.Builder<Mutation.Builder> implements MutationOrBuilder

A mutation to apply to an entity.

Protobuf type google.datastore.v1.Mutation

Implements

MutationOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Mutation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Mutation.Builder
Overrides

build()

public Mutation build()
Returns
Type Description
Mutation

buildPartial()

public Mutation buildPartial()
Returns
Type Description
Mutation

clear()

public Mutation.Builder clear()
Returns
Type Description
Mutation.Builder
Overrides

clearBaseVersion()

public Mutation.Builder clearBaseVersion()

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
Mutation.Builder

This builder for chaining.

clearConflictDetectionStrategy()

public Mutation.Builder clearConflictDetectionStrategy()
Returns
Type Description
Mutation.Builder

clearDelete()

public Mutation.Builder clearDelete()

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
Mutation.Builder

clearField(Descriptors.FieldDescriptor field)

public Mutation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Mutation.Builder
Overrides

clearInsert()

public Mutation.Builder clearInsert()

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
Mutation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Mutation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Mutation.Builder
Overrides

clearOperation()

public Mutation.Builder clearOperation()
Returns
Type Description
Mutation.Builder

clearPropertyMask()

public Mutation.Builder clearPropertyMask()

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
Mutation.Builder

clearUpdate()

public Mutation.Builder clearUpdate()

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

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

Returns
Type Description
Mutation.Builder

clearUpdateTime()

public Mutation.Builder clearUpdateTime()

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
Mutation.Builder

clearUpsert()

public Mutation.Builder clearUpsert()

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
Mutation.Builder

clone()

public Mutation.Builder clone()
Returns
Type Description
Mutation.Builder
Overrides

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;

Returns
Type Description
long

The baseVersion.

getConflictDetectionStrategyCase()

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

getDefaultInstanceForType()

public Mutation getDefaultInstanceForType()
Returns
Type Description
Mutation

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;

Returns
Type Description
Key

The delete.

getDeleteBuilder()

public Key.Builder getDeleteBuilder()

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

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;

Returns
Type Description
KeyOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
Entity

The insert.

getInsertBuilder()

public Entity.Builder getInsertBuilder()

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

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;

Returns
Type Description
EntityOrBuilder

getOperationCase()

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

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;

Returns
Type Description
PropertyMask

The propertyMask.

getPropertyMaskBuilder()

public PropertyMask.Builder getPropertyMaskBuilder()

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

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;

Returns
Type Description
PropertyMaskOrBuilder

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;

Returns
Type Description
Entity

The update.

getUpdateBuilder()

public Entity.Builder getUpdateBuilder()

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

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;

Returns
Type Description
EntityOrBuilder

getUpdateTime()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

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

getUpsertBuilder()

public Entity.Builder getUpsertBuilder()

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

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;

Returns
Type Description
EntityOrBuilder

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;

Returns
Type Description
boolean

Whether the baseVersion field is set.

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;

Returns
Type Description
boolean

Whether the delete field is set.

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;

Returns
Type Description
boolean

Whether the insert field is set.

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;

Returns
Type Description
boolean

Whether the propertyMask field is set.

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;

Returns
Type Description
boolean

Whether the update field is set.

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;

Returns
Type Description
boolean

Whether the updateTime field is set.

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;

Returns
Type Description
boolean

Whether the upsert field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDelete(Key value)

public Mutation.Builder mergeDelete(Key value)

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;

Parameter
Name Description
value Key
Returns
Type Description
Mutation.Builder

mergeFrom(Mutation other)

public Mutation.Builder mergeFrom(Mutation other)
Parameter
Name Description
other Mutation
Returns
Type Description
Mutation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Mutation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mutation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Mutation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Mutation.Builder
Overrides

mergeInsert(Entity value)

public Mutation.Builder mergeInsert(Entity value)

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;

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

mergePropertyMask(PropertyMask value)

public Mutation.Builder mergePropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
Mutation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Mutation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Mutation.Builder
Overrides

mergeUpdate(Entity value)

public Mutation.Builder mergeUpdate(Entity value)

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

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

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

mergeUpdateTime(Timestamp value)

public Mutation.Builder mergeUpdateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Mutation.Builder

mergeUpsert(Entity value)

public Mutation.Builder mergeUpsert(Entity value)

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;

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

setBaseVersion(long value)

public Mutation.Builder setBaseVersion(long value)

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;

Parameter
Name Description
value long

The baseVersion to set.

Returns
Type Description
Mutation.Builder

This builder for chaining.

setDelete(Key value)

public Mutation.Builder setDelete(Key value)

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;

Parameter
Name Description
value Key
Returns
Type Description
Mutation.Builder

setDelete(Key.Builder builderForValue)

public Mutation.Builder setDelete(Key.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Key.Builder
Returns
Type Description
Mutation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Mutation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Mutation.Builder
Overrides

setInsert(Entity value)

public Mutation.Builder setInsert(Entity value)

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;

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

setInsert(Entity.Builder builderForValue)

public Mutation.Builder setInsert(Entity.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Entity.Builder
Returns
Type Description
Mutation.Builder

setPropertyMask(PropertyMask value)

public Mutation.Builder setPropertyMask(PropertyMask value)

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;

Parameter
Name Description
value PropertyMask
Returns
Type Description
Mutation.Builder

setPropertyMask(PropertyMask.Builder builderForValue)

public Mutation.Builder setPropertyMask(PropertyMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue PropertyMask.Builder
Returns
Type Description
Mutation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Mutation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Mutation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Mutation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Mutation.Builder
Overrides

setUpdate(Entity value)

public Mutation.Builder setUpdate(Entity value)

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

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

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

setUpdate(Entity.Builder builderForValue)

public Mutation.Builder setUpdate(Entity.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Entity.Builder
Returns
Type Description
Mutation.Builder

setUpdateTime(Timestamp value)

public Mutation.Builder setUpdateTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
Mutation.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Mutation.Builder setUpdateTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Mutation.Builder

setUpsert(Entity value)

public Mutation.Builder setUpsert(Entity value)

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;

Parameter
Name Description
value Entity
Returns
Type Description
Mutation.Builder

setUpsert(Entity.Builder builderForValue)

public Mutation.Builder setUpsert(Entity.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Entity.Builder
Returns
Type Description
Mutation.Builder