com.google.api.services.spanner.v1.model

Class Mutation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.Mutation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Mutation
extends com.google.api.client.json.GenericJson

A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Mutation()

Method Summary

Modifier and Type	Method and Description
Mutation	clone()
Delete	getDelete() Delete rows from a table.
Write	getInsert() Insert new rows in a table.
Write	getInsertOrUpdate() Like insert, except that if the row already exists, then its column values are overwritten with the ones provided.
Write	getReplace() Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead.
Write	getUpdate() Update existing rows in a table.
Mutation	set(String fieldName, Object value)
Mutation	setDelete(Delete delete) Delete rows from a table.
Mutation	setInsert(Write insert) Insert new rows in a table.
Mutation	setInsertOrUpdate(Write insertOrUpdate) Like insert, except that if the row already exists, then its column values are overwritten with the ones provided.
Mutation	setReplace(Write replace) Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead.
Mutation	setUpdate(Write update) Update existing rows in a table.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Mutation

public Mutation()

Method Detail

getDelete

public Delete getDelete()

Delete rows from a table. Succeeds whether or not the named rows were present.

Returns:

value or null for none

setDelete

public Mutation setDelete(Delete delete)

Delete rows from a table. Succeeds whether or not the named rows were present.

Parameters:

delete - delete or null for none

getInsert

public Write getInsert()

Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`.

Returns:

value or null for none

setInsert

public Mutation setInsert(Write insert)

Insert new rows in a table. If any of the rows already exist, the write or transaction fails with error `ALREADY_EXISTS`.

Parameters:

insert - insert or null for none

getInsertOrUpdate

public Write getInsertOrUpdate()

Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. When using insert_or_update, just as when using insert, all `NOT NULL` columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

Returns:

value or null for none

setInsertOrUpdate

public Mutation setInsertOrUpdate(Write insertOrUpdate)

Like insert, except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved. When using insert_or_update, just as when using insert, all `NOT NULL` columns in the table must be given a value. This holds true even when the row already exists and will therefore actually be updated.

Parameters:

insertOrUpdate - insertOrUpdate or null for none

getReplace

public Write getReplace()

Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

Returns:

value or null for none

setReplace

public Mutation setReplace(Write replace)

Like insert, except that if the row already exists, it is deleted, and the column values provided are inserted instead. Unlike insert_or_update, this means any values not explicitly written become `NULL`. In an interleaved table, if you create the child table with the `ON DELETE CASCADE` annotation, then replacing a parent row also deletes the child rows. Otherwise, you must delete the child rows before you replace the parent row.

Parameters:

replace - replace or null for none

getUpdate

public Write getUpdate()

Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`.

Returns:

value or null for none

setUpdate

public Mutation setUpdate(Write update)

Update existing rows in a table. If any of the rows does not already exist, the transaction fails with error `NOT_FOUND`.

Parameters:

update - update or null for none

set

public Mutation set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Mutation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson