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

Class RefreshDataSourceRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.

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

Method Summary

Modifier and Type	Method and Description
RefreshDataSourceRequest	clone()
String	getDataSourceId() Reference to a DataSource.
Boolean	getForce() Refreshes the data source objects regardless of the current state.
Boolean	getIsAll() Refreshes all existing data source objects in the spreadsheet.
DataSourceObjectReferences	getReferences() References to data source objects to refresh.
RefreshDataSourceRequest	set(String fieldName, Object value)
RefreshDataSourceRequest	setDataSourceId(String dataSourceId) Reference to a DataSource.
RefreshDataSourceRequest	setForce(Boolean force) Refreshes the data source objects regardless of the current state.
RefreshDataSourceRequest	setIsAll(Boolean isAll) Refreshes all existing data source objects in the spreadsheet.
RefreshDataSourceRequest	setReferences(DataSourceObjectReferences references) References to data source objects to refresh.

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

RefreshDataSourceRequest

public RefreshDataSourceRequest()

Method Detail

getDataSourceId

public String getDataSourceId()

Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.

Returns:

value or null for none

setDataSourceId

public RefreshDataSourceRequest setDataSourceId(String dataSourceId)

Reference to a DataSource. If specified, refreshes all associated data source objects for the data source.

Parameters:

dataSourceId - dataSourceId or null for none

getForce

public Boolean getForce()

Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.

Returns:

value or null for none

setForce

public RefreshDataSourceRequest setForce(Boolean force)

Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately.

Parameters:

force - force or null for none

getIsAll

public Boolean getIsAll()

Refreshes all existing data source objects in the spreadsheet.

Returns:

value or null for none

setIsAll

public RefreshDataSourceRequest setIsAll(Boolean isAll)

Refreshes all existing data source objects in the spreadsheet.

Parameters:

isAll - isAll or null for none

getReferences

public DataSourceObjectReferences getReferences()

References to data source objects to refresh.

Returns:

value or null for none

setReferences

public RefreshDataSourceRequest setReferences(DataSourceObjectReferences references)

References to data source objects to refresh.

Parameters:

references - references or null for none

set

public RefreshDataSourceRequest set(String fieldName,
                                    Object value)

Overrides:

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

clone

public RefreshDataSourceRequest clone()

Overrides:

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