Contains select multiple information for the config. Its properties determine how the select multiple is displayed in Data Studio.
Usage:
constcc=DataStudioApp.createCommunityConnector();constconfig=cc.getConfig();constoption1=config.newOptionBuilder().setLabel('option label').setValue('option_value');constoption2=config.newOptionBuilder().setLabel('second option label').setValue('option_value_2');constinfo1=config.newSelectMultiple().setId('api_endpoint').setName('Data Type').setHelpText('Select the data type you\'re interested in.').setAllowOverride(true).addOption(option1).addOption(option2);
Methods
Method | Return type | Brief description |
---|---|---|
add | Select | Adds a new select option. |
set | Select | Enables overriding for this config entry. |
set | Select | Sets the help text for this configuration entry. |
set | Select | Sets the unique ID for this configuration entry. |
set | Select | Sets the dynamic status for this configuration entry. |
set | Select | Sets the display name for this configuration entry. |
Detailed documentation
addOption(optionBuilder)
Adds a new select option.
Parameters
Name | Type | Description |
---|---|---|
option | Option | A builder for an option. |
Return
Select
— This builder, for chaining.
setAllowOverride(allowOverride)
Enables overriding for this config entry. If set to true
, data source creators have the option to enable this for report editors.
Parameters
Name | Type | Description |
---|---|---|
allow | Boolean | Whether or not this config entry can be overridden in reports. |
Return
Select
— This builder, for chaining.
setHelpText(helpText)
Sets the help text for this configuration entry.
Parameters
Name | Type | Description |
---|---|---|
help | String | The help text to set. |
Return
Select
— This builder, for chaining.
setId(id)
Sets the unique ID for this configuration entry.
Parameters
Name | Type | Description |
---|---|---|
id | String | The ID to set. |
Return
Select
— This builder, for chaining.
setIsDynamic(isDynamic)
Sets the dynamic status for this configuration entry.
If a dynamic configuration entry is modified, subsequent configuration entries are cleared.
Parameters
Name | Type | Description |
---|---|---|
is | Boolean | The dynamic status to set. |
Return
Select
— This builder, for chaining.
setName(name)
Sets the display name for this configuration entry.
Parameters
Name | Type | Description |
---|---|---|
name | String | The name to set. |
Return
Select
— This builder, for chaining.