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

Class BatchWriteRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request for BatchWrite.

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

Method Summary

Modifier and Type	Method and Description
BatchWriteRequest	clone()
Boolean	getExcludeTxnFromChangeStreams() Optional.
List<MutationGroup>	getMutationGroups() Required.
RequestOptions	getRequestOptions() Common options for this request.
BatchWriteRequest	set(String fieldName, Object value)
BatchWriteRequest	setExcludeTxnFromChangeStreams(Boolean excludeTxnFromChangeStreams) Optional.
BatchWriteRequest	setMutationGroups(List<MutationGroup> mutationGroups) Required.
BatchWriteRequest	setRequestOptions(RequestOptions requestOptions) Common options for this request.

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

BatchWriteRequest

public BatchWriteRequest()

Method Detail

getExcludeTxnFromChangeStreams

public Boolean getExcludeTxnFromChangeStreams()

Optional. If you don't set the `exclude_txn_from_change_streams` option or if it's set to `false`, then any change streams monitoring columns modified by transactions will capture the updates made within that transaction.

Returns:

value or null for none

setExcludeTxnFromChangeStreams

public BatchWriteRequest setExcludeTxnFromChangeStreams(Boolean excludeTxnFromChangeStreams)

Optional. If you don't set the `exclude_txn_from_change_streams` option or if it's set to `false`, then any change streams monitoring columns modified by transactions will capture the updates made within that transaction.

Parameters:

excludeTxnFromChangeStreams - excludeTxnFromChangeStreams or null for none

getMutationGroups

public List<MutationGroup> getMutationGroups()

Required. The groups of mutations to be applied.

Returns:

value or null for none

setMutationGroups

public BatchWriteRequest setMutationGroups(List<MutationGroup> mutationGroups)

Required. The groups of mutations to be applied.

Parameters:

mutationGroups - mutationGroups or null for none

getRequestOptions

public RequestOptions getRequestOptions()

Common options for this request.

Returns:

value or null for none

setRequestOptions

public BatchWriteRequest setRequestOptions(RequestOptions requestOptions)

Common options for this request.

Parameters:

requestOptions - requestOptions or null for none

set

public BatchWriteRequest set(String fieldName,
                             Object value)

Overrides:

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

clone

public BatchWriteRequest clone()

Overrides:

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