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

Class CancelDataSourceRefreshRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.

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

Method Summary

Modifier and Type	Method and Description
CancelDataSourceRefreshRequest	clone()
String	getDataSourceId() Reference to a DataSource.
Boolean	getIsAll() Cancels all existing data source object refreshes for all data sources in the spreadsheet.
DataSourceObjectReferences	getReferences() References to data source objects whose refreshes are to be cancelled.
CancelDataSourceRefreshRequest	set(String fieldName, Object value)
CancelDataSourceRefreshRequest	setDataSourceId(String dataSourceId) Reference to a DataSource.
CancelDataSourceRefreshRequest	setIsAll(Boolean isAll) Cancels all existing data source object refreshes for all data sources in the spreadsheet.
CancelDataSourceRefreshRequest	setReferences(DataSourceObjectReferences references) References to data source objects whose refreshes are to be cancelled.

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

CancelDataSourceRefreshRequest

public CancelDataSourceRefreshRequest()

Method Detail

getDataSourceId

public String getDataSourceId()

Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.

Returns:

value or null for none

setDataSourceId

public CancelDataSourceRefreshRequest setDataSourceId(String dataSourceId)

Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source.

Parameters:

dataSourceId - dataSourceId or null for none

getIsAll

public Boolean getIsAll()

Cancels all existing data source object refreshes for all data sources in the spreadsheet.

Returns:

value or null for none

setIsAll

public CancelDataSourceRefreshRequest setIsAll(Boolean isAll)

Cancels all existing data source object refreshes for all data sources in the spreadsheet.

Parameters:

isAll - isAll or null for none

getReferences

public DataSourceObjectReferences getReferences()

References to data source objects whose refreshes are to be cancelled.

Returns:

value or null for none

setReferences

public CancelDataSourceRefreshRequest setReferences(DataSourceObjectReferences references)

References to data source objects whose refreshes are to be cancelled.

Parameters:

references - references or null for none

set

public CancelDataSourceRefreshRequest set(String fieldName,
                                          Object value)

Overrides:

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

clone

public CancelDataSourceRefreshRequest clone()

Overrides:

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