com.google.api.services.sheets.v4.model

Class DataSourceParameter

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.sheets.v4.model.DataSourceParameter

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.

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 Google Sheets 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
DataSourceParameter()

Method Summary

Modifier and Type	Method and Description
DataSourceParameter	clone()
String	getName() Named parameter.
String	getNamedRangeId() ID of a NamedRange.
GridRange	getRange() A range that contains the value of the parameter.
DataSourceParameter	set(String fieldName, Object value)
DataSourceParameter	setName(String name) Named parameter.
DataSourceParameter	setNamedRangeId(String namedRangeId) ID of a NamedRange.
DataSourceParameter	setRange(GridRange range) A range that contains the value of the parameter.

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

DataSourceParameter

public DataSourceParameter()

Method Detail

getName

public String getName()

Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard- sql/lexical#identifiers).

Returns:

value or null for none

setName

public DataSourceParameter setName(String name)

Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard- sql/lexical#identifiers).

Parameters:

name - name or null for none

getNamedRangeId

public String getNamedRangeId()

ID of a NamedRange. Its size must be 1x1.

Returns:

value or null for none

setNamedRangeId

public DataSourceParameter setNamedRangeId(String namedRangeId)

ID of a NamedRange. Its size must be 1x1.

Parameters:

namedRangeId - namedRangeId or null for none

getRange

public GridRange getRange()

A range that contains the value of the parameter. Its size must be 1x1.

Returns:

value or null for none

setRange

public DataSourceParameter setRange(GridRange range)

A range that contains the value of the parameter. Its size must be 1x1.

Parameters:

range - range or null for none

set

public DataSourceParameter set(String fieldName,
                               Object value)

Overrides:

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

clone

public DataSourceParameter clone()

Overrides:

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