Google Cloud Chronicle V1 Client - Class AdvancedFilterConfig (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class AdvancedFilterConfig.

Advanced filter configuration for the filter widget.

Generated from protobuf message google.cloud.chronicle.v1.AdvancedFilterConfig

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ token`	`string` Required. The token name to look for in the query (e.g., "hostname"). The system will automatically wrap this in '$' (e.g., "$hostname$").
`↳ prefix`	`string` Optional. String to prepend to the final replaced value (e.g., "/", "^(", """).
`↳ suffix`	`string` Optional. String to append to the final replaced value (e.g., "/", ")$", """).
`↳ separator`	`string` Optional. Delimiter to join multiple selected values (e.g., "\|", " OR field = ").
`↳ multiple_allowed`	`bool` Optional. Whether to allow selection of multiple values.
`↳ default_values`	`string[]` Optional. Default values to use if no value is selected/provided.
`↳ skip_default_affixes`	`bool` Optional. Whether to skip the configured prefix and suffix when using default values. If true, default values are inserted raw (joined by the separator).
`↳ value_source`	`AdvancedFilterConfig\ValueSource` Required. Source of the values for the filter.

getToken

Required. The token name to look for in the query (e.g., "hostname").

The system will automatically wrap this in '$' (e.g., "$hostname$").

Returns
Type	Description
`string`

setToken

Required. The token name to look for in the query (e.g., "hostname").

The system will automatically wrap this in '$' (e.g., "$hostname$").

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrefix

Optional. String to prepend to the final replaced value (e.g., "/", "^(", """).

Returns
Type	Description
`string`

setPrefix

Optional. String to prepend to the final replaced value (e.g., "/", "^(", """).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSuffix

Optional. String to append to the final replaced value (e.g., "/", ")$", """).

Returns
Type	Description
`string`

setSuffix

Optional. String to append to the final replaced value (e.g., "/", ")$", """).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSeparator

Optional. Delimiter to join multiple selected values (e.g., "|", " OR field = ").

Returns
Type	Description
`string`

setSeparator

Optional. Delimiter to join multiple selected values (e.g., "|", " OR field = ").

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMultipleAllowed

Optional. Whether to allow selection of multiple values.

Returns
Type	Description
`bool`

setMultipleAllowed

Optional. Whether to allow selection of multiple values.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDefaultValues

Optional. Default values to use if no value is selected/provided.

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setDefaultValues