Google Cloud Chronicle V1 Client - Class DeleteWatchlistRequest (0.1.2)

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

Request message for deleting watchlist.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the watchlist to delete. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}
↳ force bool

Optional. If set to true, any entities under this watchlist will also be deleted. (Otherwise, the request will only work if the watchlist has no entities.)

getName

Required. The name of the watchlist to delete.

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

Returns
Type Description
string

setName

Required. The name of the watchlist to delete.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. If set to true, any entities under this watchlist will also be deleted. (Otherwise, the request will only work if the watchlist has no entities.)

Returns
Type Description
bool

setForce

Optional. If set to true, any entities under this watchlist will also be deleted. (Otherwise, the request will only work if the watchlist has no entities.)

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The name of the watchlist to delete. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist} Please see EntityServiceClient::watchlistName() for help formatting this field.
force bool

Optional. If set to true, any entities under this watchlist will also be deleted. (Otherwise, the request will only work if the watchlist has no entities.)
Returns
Type Description
DeleteWatchlistRequest