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 \ V1Methods
__construct
Constructor.
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
↳ entity_count
↳ create_time
↳ update_time
↳ watchlist_user_preferences
getName
Identifier. Resource name of the watchlist.
Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}
string
setName
Identifier. Resource name of the watchlist.
Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}
var
string
$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 ).
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 ).
var
string
$this
getDescription
Optional. Description of the watchlist.
string
setDescription
Optional. Description of the watchlist.
var
string
$this
getMultiplyingFactor
Optional. Weight applied to the risk score for entities in this watchlist.
The default is 1.0 if it is not specified.
float
setMultiplyingFactor
Optional. Weight applied to the risk score for entities in this watchlist.
The default is 1.0 if it is not specified.
var
float
$this
getEntityPopulationMechanism
Required. Mechanism to populate entities in the watchlist.
hasEntityPopulationMechanism
clearEntityPopulationMechanism
setEntityPopulationMechanism
Required. Mechanism to populate entities in the watchlist.
$this
getEntityCount
Output only. Entity count in the watchlist.
hasEntityCount
clearEntityCount
setEntityCount
Output only. Entity count in the watchlist.
$this
getCreateTime
Output only. Time the watchlist was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time the watchlist was created.
$this
getUpdateTime
Output only. Time the watchlist was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time the watchlist was last updated.
$this
getWatchlistUserPreferences
Optional. User preferences for watchlist configuration.
hasWatchlistUserPreferences
clearWatchlistUserPreferences
setWatchlistUserPreferences
Optional. User preferences for watchlist configuration.
$this
