Contains select single information for the config. Its properties determine how the select single is displayed in Data Studio.
var option1 = config . newOptionBuilder () . setLabel ( "option label" ) . setValue ( "option_value" ); var option2 = config . newOptionBuilder () . setLabel ( "second option label" ) . setValue ( "option_value_2" ); var info1 = config . newSelectSingle () . 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 |
---|---|---|
SelectSingle
|
Adds a new select option. | |
SelectSingle
|
Enables overriding for this config entry. | |
SelectSingle
|
Sets the help text for this configuration entry. | |
SelectSingle
|
Sets the unique ID for this configuration entry. | |
SelectSingle
|
Sets the dynamic status for this configuration entry. | |
SelectSingle
|
Sets the display name for this configuration entry. |
Detailed documentation
addOption(optionBuilder)
Adds a new select option.
Parameters
Name | Type | Description |
---|---|---|
optionBuilder
|
OptionBuilder
|
A builder for an option. |
Return
SelectSingle
— 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 |
---|---|---|
allowOverride
|
Boolean
|
Whether or not this config entry can be overridden in reports. |
Return
SelectSingle
— This builder, for chaining.
setHelpText(helpText)
Sets the help text for this configuration entry.
Parameters
Name | Type | Description |
---|---|---|
helpText
|
String
|
The helpText to set. |
Return
SelectSingle
— 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
SelectSingle
— 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 |
---|---|---|
isDynamic
|
Boolean
|
The dynamic status to set. |
Return
SelectSingle
— 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
SelectSingle
— This builder, for chaining.