Class Mutation.Builder (2.22.0)

publicstaticfinalclass Mutation.BuilderextendsGeneratedMessageV3.Builder<Mutation.Builder>implementsMutationOrBuilder

A mutation to apply to an entity.

Protobuf type google.datastore.v1.Mutation

Implements

MutationOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicMutation.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Mutation.Builder
Overrides

build()

publicMutationbuild()
Returns
Type Description
Mutation

buildPartial()

publicMutationbuildPartial()
Returns
Type Description
Mutation

clear()

publicMutation.Builderclear()
Returns
Type Description
Mutation.Builder
Overrides

clearBaseVersion()

publicMutation.BuilderclearBaseVersion()

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()

publicMutation.BuilderclearConflictDetectionStrategy()
Returns
Type Description
Mutation.Builder

clearDelete()

publicMutation.BuilderclearDelete()

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)

publicMutation.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Mutation.Builder
Overrides

clearInsert()

publicMutation.BuilderclearInsert()

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)

publicMutation.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Mutation.Builder
Overrides

clearOperation()

publicMutation.BuilderclearOperation()
Returns
Type Description
Mutation.Builder

clearPropertyMask()

publicMutation.BuilderclearPropertyMask()

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()

publicMutation.BuilderclearUpdate()

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()

publicMutation.BuilderclearUpdateTime()

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()

publicMutation.BuilderclearUpsert()

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()

publicMutation.Builderclone()
Returns
Type Description
Mutation.Builder
Overrides

getBaseVersion()

publiclonggetBaseVersion()

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()

publicMutation.ConflictDetectionStrategyCasegetConflictDetectionStrategyCase()
Returns
Type Description
Mutation.ConflictDetectionStrategyCase

getDefaultInstanceForType()

publicMutationgetDefaultInstanceForType()
Returns
Type Description
Mutation

getDelete()

publicKeygetDelete()

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()

publicKey.BuildergetDeleteBuilder()

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()

publicKeyOrBuildergetDeleteOrBuilder()

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()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInsert()

publicEntitygetInsert()

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()

publicEntity.BuildergetInsertBuilder()

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()

publicEntityOrBuildergetInsertOrBuilder()

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()

publicMutation.OperationCasegetOperationCase()
Returns
Type Description
Mutation.OperationCase

getPropertyMask()

publicPropertyMaskgetPropertyMask()

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()

publicPropertyMask.BuildergetPropertyMaskBuilder()

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()

publicPropertyMaskOrBuildergetPropertyMaskOrBuilder()

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()

publicEntitygetUpdate()

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()

publicEntity.BuildergetUpdateBuilder()

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()

publicEntityOrBuildergetUpdateOrBuilder()

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()

publicTimestampgetUpdateTime()

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()

publicTimestamp.BuildergetUpdateTimeBuilder()

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()

publicTimestampOrBuildergetUpdateTimeOrBuilder()

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()

publicEntitygetUpsert()

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()

publicEntity.BuildergetUpsertBuilder()

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()

publicEntityOrBuildergetUpsertOrBuilder()

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()

publicbooleanhasBaseVersion()

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()

publicbooleanhasDelete()

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()

publicbooleanhasInsert()

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()

publicbooleanhasPropertyMask()

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()

publicbooleanhasUpdate()

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()

publicbooleanhasUpdateTime()

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()

publicbooleanhasUpsert()

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()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeDelete(Key value)

publicMutation.BuildermergeDelete(Keyvalue)

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)

publicMutation.BuildermergeFrom(Mutationother)
Parameter
Name Description
other Mutation
Returns
Type Description
Mutation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicMutation.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Mutation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicMutation.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Mutation.Builder
Overrides

mergeInsert(Entity value)

publicMutation.BuildermergeInsert(Entityvalue)

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)

publicMutation.BuildermergePropertyMask(PropertyMaskvalue)

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)

publicfinalMutation.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Mutation.Builder
Overrides

mergeUpdate(Entity value)

publicMutation.BuildermergeUpdate(Entityvalue)

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)

publicMutation.BuildermergeUpdateTime(Timestampvalue)

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)

publicMutation.BuildermergeUpsert(Entityvalue)

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)

publicMutation.BuildersetBaseVersion(longvalue)

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)

publicMutation.BuildersetDelete(Keyvalue)

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)

publicMutation.BuildersetDelete(Key.BuilderbuilderForValue)

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)

publicMutation.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Mutation.Builder
Overrides

setInsert(Entity value)

publicMutation.BuildersetInsert(Entityvalue)

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)

publicMutation.BuildersetInsert(Entity.BuilderbuilderForValue)

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)

publicMutation.BuildersetPropertyMask(PropertyMaskvalue)

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)

publicMutation.BuildersetPropertyMask(PropertyMask.BuilderbuilderForValue)

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)

publicMutation.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Mutation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalMutation.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Mutation.Builder
Overrides

setUpdate(Entity value)

publicMutation.BuildersetUpdate(Entityvalue)

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)

publicMutation.BuildersetUpdate(Entity.BuilderbuilderForValue)

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)

publicMutation.BuildersetUpdateTime(Timestampvalue)

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)

publicMutation.BuildersetUpdateTime(Timestamp.BuilderbuilderForValue)

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)

publicMutation.BuildersetUpsert(Entityvalue)

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)

publicMutation.BuildersetUpsert(Entity.BuilderbuilderForValue)

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.