GoogleAppsCardV1SelectionInput (Google Chat API v1-rev20251118-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.chat.v1.model.GoogleAppsCardV1SelectionInput

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleAppsCardV1SelectionInput
extends com.google.api.client.json.GenericJson
```
A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card- dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
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 Chat 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

GoogleAppsCardV1SelectionInput()

Constructors
Constructor and Description
`GoogleAppsCardV1SelectionInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleAppsCardV1SelectionInput`	`clone()`
`List<GoogleAppsCardV1DataSourceConfig>`	`getDataSourceConfigs()` Optional.
`GoogleAppsCardV1Action`	`getExternalDataSource()` An external data source, such as a relational database.
`String`	`getHintText()` Optional.
`List<GoogleAppsCardV1SelectionItem>`	`getItems()` An array of selectable items.
`String`	`getLabel()` The text that appears above the selection input field in the user interface.
`Integer`	`getMultiSelectMaxSelectedItems()` For multiselect menus, the maximum number of items that a user can select.
`Integer`	`getMultiSelectMinQueryLength()` For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.
`String`	`getName()` Required.
`GoogleAppsCardV1Action`	`getOnChangeAction()` If specified, the form is submitted when the selection changes.
`GoogleAppsCardV1PlatformDataSource`	`getPlatformDataSource()` A data source from Google Workspace.
`String`	`getType()` The type of items that are displayed to users in a `SelectionInput` widget.
`GoogleAppsCardV1SelectionInput`	`set(String fieldName, Object value)`
`GoogleAppsCardV1SelectionInput`	`setDataSourceConfigs(List<GoogleAppsCardV1DataSourceConfig> dataSourceConfigs)` Optional.
`GoogleAppsCardV1SelectionInput`	`setExternalDataSource(GoogleAppsCardV1Action externalDataSource)` An external data source, such as a relational database.
`GoogleAppsCardV1SelectionInput`	`setHintText(String hintText)` Optional.
`GoogleAppsCardV1SelectionInput`	`setItems(List<GoogleAppsCardV1SelectionItem> items)` An array of selectable items.
`GoogleAppsCardV1SelectionInput`	`setLabel(String label)` The text that appears above the selection input field in the user interface.
`GoogleAppsCardV1SelectionInput`	`setMultiSelectMaxSelectedItems(Integer multiSelectMaxSelectedItems)` For multiselect menus, the maximum number of items that a user can select.
`GoogleAppsCardV1SelectionInput`	`setMultiSelectMinQueryLength(Integer multiSelectMinQueryLength)` For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items.
`GoogleAppsCardV1SelectionInput`	`setName(String name)` Required.
`GoogleAppsCardV1SelectionInput`	`setOnChangeAction(GoogleAppsCardV1Action onChangeAction)` If specified, the form is submitted when the selection changes.
`GoogleAppsCardV1SelectionInput`	`setPlatformDataSource(GoogleAppsCardV1PlatformDataSource platformDataSource)` A data source from Google Workspace.
`GoogleAppsCardV1SelectionInput`	`setType(String type)` The type of items that are displayed to users in a `SelectionInput` widget.

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
  - GoogleAppsCardV1SelectionInput
```
public GoogleAppsCardV1SelectionInput()
```
- Method Detail
  - getDataSourceConfigs
```
public List<GoogleAppsCardV1DataSourceConfig> getDataSourceConfigs()
```
    Optional. The data source configs for the selection control. This field provides more fine- grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Returns:
    
    value or null for none
  - setDataSourceConfigs
```
public GoogleAppsCardV1SelectionInput setDataSourceConfigs(List<GoogleAppsCardV1DataSourceConfig> dataSourceConfigs)
```
    Optional. The data source configs for the selection control. This field provides more fine- grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Parameters:
    
    dataSourceConfigs - dataSourceConfigs or null for none
  - getExternalDataSource
```
public GoogleAppsCardV1Action getExternalDataSource()
```
    An external data source, such as a relational database.
    
    Returns:
    
    value or null for none
  - setExternalDataSource
```
public GoogleAppsCardV1SelectionInput setExternalDataSource(GoogleAppsCardV1Action externalDataSource)
```
    An external data source, such as a relational database.
    
    Parameters:
    
    externalDataSource - externalDataSource or null for none
  - getHintText
```
public String getHintText()
```
    Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add- ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Returns:
    
    value or null for none
  - setHintText
```
public GoogleAppsCardV1SelectionInput setHintText(String hintText)
```
    Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Available for Google Workspace add- ons that extend Google Workspace flows, which is available as part of the [Gemini Alpha program](https://support.google.com/a/answer/14170809). Unavailable for Google Chat apps.
    
    Parameters:
    
    hintText - hintText or null for none
  - getItems
```
public List<GoogleAppsCardV1SelectionItem> getItems()
```
    An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
    
    Returns:
    
    value or null for none
  - setItems
```
public GoogleAppsCardV1SelectionInput setItems(List<GoogleAppsCardV1SelectionItem> items)
```
    An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
    
    Parameters:
    
    items - items or null for none
  - getLabel
```
public String getLabel()
```
    The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
    
    Returns:
    
    value or null for none
  - setLabel
```
public GoogleAppsCardV1SelectionInput setLabel(String label)
```
    The text that appears above the selection input field in the user interface. Specify text that helps the user enter the information your app needs. For example, if users are selecting the urgency of a work ticket from a drop-down menu, the label might be "Urgency" or "Select urgency".
    
    Parameters:
    
    label - label or null for none
  - getMultiSelectMaxSelectedItems
```
public Integer getMultiSelectMaxSelectedItems()
```
    For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
    
    Returns:
    
    value or null for none
  - setMultiSelectMaxSelectedItems
```
public GoogleAppsCardV1SelectionInput setMultiSelectMaxSelectedItems(Integer multiSelectMaxSelectedItems)
```
    For multiselect menus, the maximum number of items that a user can select. Minimum value is 1 item. If unspecified, defaults to 3 items.
    
    Parameters:
    
    multiSelectMaxSelectedItems - multiSelectMaxSelectedItems or null for none
  - getMultiSelectMinQueryLength
```
public Integer getMultiSelectMinQueryLength()
```
    For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
    
    Returns:
    
    value or null for none
  - setMultiSelectMinQueryLength
```
public GoogleAppsCardV1SelectionInput setMultiSelectMinQueryLength(Integer multiSelectMinQueryLength)
```
    For multiselect menus, the number of text characters that a user inputs before the menu returns suggested selection items. If unset, the multiselect menu uses the following default values: * If the menu uses a static array of `SelectionInput` items, defaults to 0 characters and immediately populates items from the array. * If the menu uses a dynamic data source (`multi_select_data_source`), defaults to 3 characters before querying the data source to return suggested items.
    
    Parameters:
    
    multiSelectMinQueryLength - multiSelectMinQueryLength or null for none
  - getName
```
public String getName()
```
    Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleAppsCardV1SelectionInput setName(String name)
```
    Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
    
    Parameters:
    
    name - name or null for none
  - getOnChangeAction
```
public GoogleAppsCardV1Action getOnChangeAction()
```
    If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
    
    Returns:
    
    value or null for none
  - setOnChangeAction
```
public GoogleAppsCardV1SelectionInput setOnChangeAction(GoogleAppsCardV1Action onChangeAction)
```
    If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button that submits the form. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
    
    Parameters:
    
    onChangeAction - onChangeAction or null for none
  - getPlatformDataSource
```
public GoogleAppsCardV1PlatformDataSource getPlatformDataSource()
```
    A data source from Google Workspace.
    
    Returns:
    
    value or null for none
  - setPlatformDataSource
```
public GoogleAppsCardV1SelectionInput setPlatformDataSource(GoogleAppsCardV1PlatformDataSource platformDataSource)
```
    A data source from Google Workspace.
    
    Parameters:
    
    platformDataSource - platformDataSource or null for none
  - getType
```
public String getType()
```
    The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
    
    Returns:
    
    value or null for none
  - setType
```
public GoogleAppsCardV1SelectionInput setType(String type)
```
    The type of items that are displayed to users in a `SelectionInput` widget. Selection types support different types of interactions. For example, users can select one or more checkboxes, but they can only select one value from a dropdown menu.
    
    Parameters:
    
    type - type or null for none
  - set
```
public GoogleAppsCardV1SelectionInput set(String fieldName,
                                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleAppsCardV1SelectionInput clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleAppsCardV1SelectionInput

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleAppsCardV1SelectionInput

Method Detail

getDataSourceConfigs

setDataSourceConfigs

getExternalDataSource

setExternalDataSource

getHintText

setHintText

getItems

setItems

getLabel

setLabel

getMultiSelectMaxSelectedItems

setMultiSelectMaxSelectedItems

getMultiSelectMinQueryLength

setMultiSelectMinQueryLength

getName

setName

getOnChangeAction

setOnChangeAction

getPlatformDataSource

setPlatformDataSource

getType

setType

set

clone