REST Resource: projects.locations.instances.moduleSettings.properties

Resource: ModuleSettingsProperty

Represents a single configuration property within a module, including its current value and metadata such as its data type and display name.

JSON representation
{
  "name": string,
  "value": string,
  "type": enum (ParamType),
  "displayName": string
}
Fields
name

string

Identifier. The unique name of the module settings property.

value

string

Optional. The property value.

type

enum (ParamType)

Output only. The type of the property value.

displayName

string

Output only. The display name of the property.

ParamType

Represents a module settings property type.

Enums
PARAM_TYPE_UNSPECIFIED The type of the property value is undefined.
BOOLEAN The property value is a boolean.
INT The property value is an integer.
STRING The property value is a string.
PASSWORD The property value is a password.
IP The property value is an IP address.
IP_OR_HOST The property value is an IP address or a hostname.
URL The property value is a URL.
DNS_DOMAIN The property value is a domain.
EMAIL The property value is an email address.
VALUES_LIST The property value is a list of values.
VALUES_AS_SEMI_COLON_SEPERATED_STRING The property value is a semicolon separated string.
MULTI_VALUES_SELECTION The property value is a list of values with selection.
SCRIPT The property value is a script.
FILTER_LIST The property value is a list of values.
NUMERICAL_VALUES The property value is a list of numerical values.

Methods

batchUpdate

Updates multiple properties within a single module.

get

Gets a single ModuleSettingsProperty.

list

Lists all properties of a given module setting.

patch

Updates a single property of a module setting.

testSettings

Tests the provided configuration properties.