Google Cloud Chronicle V1 Client - Class Watchlist (0.1.2)

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

A watchlist is a list of entities that allows for bulk operations over the included entities.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. Resource name of the watchlist. Format: `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
`↳ display_name`	`string` Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).
`↳ description`	`string` Optional. Description of the watchlist.
`↳ multiplying_factor`	`float` Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
`↳ entity_population_mechanism`	`Watchlist\EntityPopulationMechanism` Required. Mechanism to populate entities in the watchlist.
`↳ entity_count`	`Watchlist\EntityCount` Output only. Entity count in the watchlist.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time the watchlist was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Time the watchlist was last updated.
`↳ watchlist_user_preferences`	`WatchlistUserPreferences` Optional. User preferences for watchlist configuration.

getName

Identifier. Resource name of the watchlist.

Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

Returns
Type	Description
`string`

setName

Identifier. Resource name of the watchlist.

Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. Display name of the watchlist.

Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

Returns
Type	Description
`string`

setDisplayName

Required. Display name of the watchlist.

Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the watchlist.

Returns
Type	Description
`string`

setDescription

Optional. Description of the watchlist.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMultiplyingFactor

Optional. Weight applied to the risk score for entities in this watchlist.

The default is 1.0 if it is not specified.

Returns
Type	Description
`float`

setMultiplyingFactor

Optional. Weight applied to the risk score for entities in this watchlist.

The default is 1.0 if it is not specified.

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

getEntityPopulationMechanism

Required. Mechanism to populate entities in the watchlist.

Returns
Type	Description
`Watchlist\EntityPopulationMechanism\|null`

hasEntityPopulationMechanism

clearEntityPopulationMechanism

setEntityPopulationMechanism

Required. Mechanism to populate entities in the watchlist.

Parameter
Name	Description
`var`	`Watchlist\EntityPopulationMechanism`

Returns
Type	Description
`$this`

getEntityCount

Output only. Entity count in the watchlist.

Returns
Type	Description
`Watchlist\EntityCount\|null`

hasEntityCount

clearEntityCount

setEntityCount

Output only. Entity count in the watchlist.

Parameter
Name	Description
`var`	`Watchlist\EntityCount`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time the watchlist was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime