Console
    Contact Us Start free

    REST Resource: projects.locations.instances.watchlists

    Resource: Watchlist

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

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "multiplyingFactor" 
 : 
 number 
 , 
 "entityPopulationMechanism" 
 : 
 { 
 object (  EntityPopulationMechanism 
 
) 
 } 
 , 
 "entityCount" 
 : 
 { 
 object (  EntityCount 
 
) 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "watchlistUserPreferences" 
 : 
 { 
 object (  WatchlistUserPreferences 
 
) 
 } 
 }
    Fields
    name

    string

    Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

    displayName

    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.
    multiplyingFactor

    number

    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    entityPopulationMechanism

    object ( EntityPopulationMechanism )

    Required. Mechanism to populate entities in the watchlist.
    entityCount

    object ( EntityCount )

    Output only. Entity count in the watchlist.
    createTime

    string ( Timestamp format)

    Output only. Time the watchlist was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. Time the watchlist was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    watchlistUserPreferences

    object ( WatchlistUserPreferences )

    Optional. User preferences for watchlist configuration.

    EntityPopulationMechanism

    Mechanism to populate entities in the watchlist.

    JSON representation 
     { 
 // Union field mechanism 
can be only one of the following: 
 "manual" 
 : 
 { 
 object (  Manual 
 
) 
 } 
 // End of list of possible types for union field mechanism 
. 
 }
    Fields
    Union field mechanism . Ways to populate entities in watchlist. Currently, only manual is supported. mechanism can be only one of the following:
    manual

    object ( Manual )

    Optional. Entities are added manually.

    Manual

    This type has no fields.

    Entities are added manually.

    EntityCount

    Count of different types of entities in the watchlist.

    JSON representation 
     { 
 "user" 
 : 
 integer 
 , 
 "asset" 
 : 
 integer 
 }
    Fields
    user

    integer

    Output only. Count of user type entities in the watchlist.
    asset

    integer

    Output only. Count of asset type entities in the watchlist.

    WatchlistUserPreferences

    A collection of user preferences for watchlist UI configuration.

    JSON representation 
     { 
 "pinned" 
 : 
 boolean 
 }
    Fields
    pinned

    boolean

    Optional. Whether the watchlist is pinned on the dashboard.

    Methods

    create

    		Creates a watchlist for the given instance.

    delete

    		Deletes the watchlist for the given instance.

    get

    		Gets watchlist details for the given watchlist ID.

    list

    		Lists all watchlists for the given instance.

    patch

    		Updates the watchlist for the given instance.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: