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

Class RequestOptions

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Common request options for various APIs.

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

Method Summary

Modifier and Type	Method and Description
RequestOptions	clone()
String	getPriority() Priority for the request.
String	getRequestTag() A per-request tag which can be applied to queries or reads, used for statistics collection.
String	getTransactionTag() A tag used for statistics collection about this transaction.
RequestOptions	set(String fieldName, Object value)
RequestOptions	setPriority(String priority) Priority for the request.
RequestOptions	setRequestTag(String requestTag) A per-request tag which can be applied to queries or reads, used for statistics collection.
RequestOptions	setTransactionTag(String transactionTag) A tag used for statistics collection about this transaction.

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

RequestOptions

public RequestOptions()

Method Detail

getPriority

public String getPriority()

Priority for the request.

Returns:

value or null for none

setPriority

public RequestOptions setPriority(String priority)

Priority for the request.

Parameters:

priority - priority or null for none

getRequestTag

public String getRequestTag()

A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

Returns:

value or null for none

setRequestTag

public RequestOptions setRequestTag(String requestTag)

A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

Parameters:

requestTag - requestTag or null for none

getTransactionTag

public String getTransactionTag()

A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

Returns:

value or null for none

setTransactionTag

public RequestOptions setTransactionTag(String transactionTag)

A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.

Parameters:

transactionTag - transactionTag or null for none

set

public RequestOptions set(String fieldName,
                          Object value)

Overrides:

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

clone

public RequestOptions clone()

Overrides:

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