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

Class SetDataValidationRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.

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

Method Summary

Modifier and Type	Method and Description
SetDataValidationRequest	clone()
Boolean	getFilteredRowsIncluded() Optional.
GridRange	getRange() The range the data validation rule should apply to.
DataValidationRule	getRule() The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.
SetDataValidationRequest	set(String fieldName, Object value)
SetDataValidationRequest	setFilteredRowsIncluded(Boolean filteredRowsIncluded) Optional.
SetDataValidationRequest	setRange(GridRange range) The range the data validation rule should apply to.
SetDataValidationRequest	setRule(DataValidationRule rule) The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.

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

SetDataValidationRequest

public SetDataValidationRequest()

Method Detail

getFilteredRowsIncluded

public Boolean getFilteredRowsIncluded()

Optional. If true, the data validation rule will be applied to the filtered rows as well.

Returns:

value or null for none

setFilteredRowsIncluded

public SetDataValidationRequest setFilteredRowsIncluded(Boolean filteredRowsIncluded)

Optional. If true, the data validation rule will be applied to the filtered rows as well.

Parameters:

filteredRowsIncluded - filteredRowsIncluded or null for none

getRange

public GridRange getRange()

The range the data validation rule should apply to.

Returns:

value or null for none

setRange

public SetDataValidationRequest setRange(GridRange range)

The range the data validation rule should apply to.

Parameters:

range - range or null for none

getRule

public DataValidationRule getRule()

The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.

Returns:

value or null for none

setRule

public SetDataValidationRequest setRule(DataValidationRule rule)

The data validation rule to set on each cell in the range, or empty to clear the data validation in the range.

Parameters:

rule - rule or null for none

set

public SetDataValidationRequest set(String fieldName,
                                    Object value)

Overrides:

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

clone

public SetDataValidationRequest clone()

Overrides:

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