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

Class DirectedReadOptions

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The `DirectedReadOptions` can be used to indicate which replicas or regions should be used for non-transactional reads or queries. `DirectedReadOptions` can only be specified for a read-only transaction, otherwise the API returns an `INVALID_ARGUMENT` error.

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

Method Summary

Modifier and Type	Method and Description
DirectedReadOptions	clone()
ExcludeReplicas	getExcludeReplicas() `Exclude_replicas` indicates that specified replicas should be excluded from serving requests.
IncludeReplicas	getIncludeReplicas() `Include_replicas` indicates the order of replicas (as they appear in this list) to process the request.
DirectedReadOptions	set(String fieldName, Object value)
DirectedReadOptions	setExcludeReplicas(ExcludeReplicas excludeReplicas) `Exclude_replicas` indicates that specified replicas should be excluded from serving requests.
DirectedReadOptions	setIncludeReplicas(IncludeReplicas includeReplicas) `Include_replicas` indicates the order of replicas (as they appear in this list) to process the 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

DirectedReadOptions

public DirectedReadOptions()

Method Detail

getExcludeReplicas

public ExcludeReplicas getExcludeReplicas()

`Exclude_replicas` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

Returns:

value or null for none

setExcludeReplicas

public DirectedReadOptions setExcludeReplicas(ExcludeReplicas excludeReplicas)

`Exclude_replicas` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

Parameters:

excludeReplicas - excludeReplicas or null for none

getIncludeReplicas

public IncludeReplicas getIncludeReplicas()

`Include_replicas` indicates the order of replicas (as they appear in this list) to process the request. If `auto_failover_disabled` is set to `true` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to `DEADLINE_EXCEEDED` errors.

Returns:

value or null for none

setIncludeReplicas

public DirectedReadOptions setIncludeReplicas(IncludeReplicas includeReplicas)

`Include_replicas` indicates the order of replicas (as they appear in this list) to process the request. If `auto_failover_disabled` is set to `true` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to `DEADLINE_EXCEEDED` errors.

Parameters:

includeReplicas - includeReplicas or null for none

set

public DirectedReadOptions set(String fieldName,
                               Object value)

Overrides:

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

clone

public DirectedReadOptions clone()

Overrides:

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