com.google.api.services.docs.v1.model

Class UpdateDropdownDefinitionPropertiesRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.UpdateDropdownDefinitionPropertiesRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Updates the properties of a DropdownDefinition.

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 Docs 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
UpdateDropdownDefinitionPropertiesRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDropdownDefinitionPropertiesRequest	clone()
String	getDropdownDefinitionId() The ID of the DropdownDefinition to update.
DropdownDefinitionProperties	getDropdownDefinitionProperties() The properties to update.
String	getFields() The fields that should be updated.
Map<String,String>	getSelectedOptionIdReplacements() A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted.
String	getTabId() The ID of the tab that contains the dropdown definition to update.
UpdateDropdownDefinitionPropertiesRequest	set(String fieldName, Object value)
UpdateDropdownDefinitionPropertiesRequest	setDropdownDefinitionId(String dropdownDefinitionId) The ID of the DropdownDefinition to update.
UpdateDropdownDefinitionPropertiesRequest	setDropdownDefinitionProperties(DropdownDefinitionProperties dropdownDefinitionProperties) The properties to update.
UpdateDropdownDefinitionPropertiesRequest	setFields(String fields) The fields that should be updated.
UpdateDropdownDefinitionPropertiesRequest	setSelectedOptionIdReplacements(Map<String,String> selectedOptionIdReplacements) A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted.
UpdateDropdownDefinitionPropertiesRequest	setTabId(String tabId) The ID of the tab that contains the dropdown definition to update.

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

UpdateDropdownDefinitionPropertiesRequest

public UpdateDropdownDefinitionPropertiesRequest()

Method Detail

getDropdownDefinitionId

public String getDropdownDefinitionId()

The ID of the DropdownDefinition to update.

Returns:

value or null for none

setDropdownDefinitionId

public UpdateDropdownDefinitionPropertiesRequest setDropdownDefinitionId(String dropdownDefinitionId)

The ID of the DropdownDefinition to update.

Parameters:

dropdownDefinitionId - dropdownDefinitionId or null for none

getDropdownDefinitionProperties

public DropdownDefinitionProperties getDropdownDefinitionProperties()

The properties to update.

Returns:

value or null for none

setDropdownDefinitionProperties

public UpdateDropdownDefinitionPropertiesRequest setDropdownDefinitionProperties(DropdownDefinitionProperties dropdownDefinitionProperties)

The properties to update.

Parameters:

dropdownDefinitionProperties - dropdownDefinitionProperties or null for none

getFields

public String getFields()

The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.

Returns:

value or null for none

setFields

public UpdateDropdownDefinitionPropertiesRequest setFields(String fields)

The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.

Parameters:

fields - fields or null for none

getSelectedOptionIdReplacements

public Map<String,String> getSelectedOptionIdReplacements()

A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"}`.

Returns:

value or null for none

setSelectedOptionIdReplacements

public UpdateDropdownDefinitionPropertiesRequest setSelectedOptionIdReplacements(Map<String,String> selectedOptionIdReplacements)

A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"}`.

Parameters:

selectedOptionIdReplacements - selectedOptionIdReplacements or null for none

getTabId

public String getTabId()

The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Returns:

value or null for none

setTabId

public UpdateDropdownDefinitionPropertiesRequest setTabId(String tabId)

The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.

Parameters:

tabId - tabId or null for none

set

public UpdateDropdownDefinitionPropertiesRequest set(String fieldName,
                                                     Object value)

Overrides:

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

clone

public UpdateDropdownDefinitionPropertiesRequest clone()

Overrides:

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