Google Cloud Chronicle V1 Client - Class CreateWatchlistRequest (0.1.2)

Version latest

• 0.1.2 (latest)
• 0.1.1

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

Request message for creating watchlist.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent resource where this watchlist will be created. Format: projects/{project}/locations/{location}/instances/{instance}
↳ watchlist_id	string Optional. The ID to use for the watchlist, which will become the final component of the watchlist's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
↳ watchlist	Watchlist Required. The watchlist to create.

getParent

Required. The parent resource where this watchlist will be created.

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

Returns
Type	Description
string

setParent

Required. The parent resource where this watchlist will be created.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWatchlistId

Optional. The ID to use for the watchlist, which will become the final component of the watchlist's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Returns
Type	Description
string

setWatchlistId

Optional. The ID to use for the watchlist, which will become the final component of the watchlist's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWatchlist

Required. The watchlist to create.

Returns
Type	Description
Watchlist|null

hasWatchlist

clearWatchlist

setWatchlist

Required. The watchlist to create.

Parameter
Name	Description
var	Watchlist

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The parent resource where this watchlist will be created. Format: projects/{project}/locations/{location}/instances/{instance} Please see EntityServiceClient::instanceName() for help formatting this field.
watchlist	Watchlist Required. The watchlist to create.
watchlistId	string Optional. The ID to use for the watchlist, which will become the final component of the watchlist's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Returns
Type	Description
CreateWatchlistRequest