Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ListWatchlistsRequest.
Request message for listing watchlists.
Generated from protobuf message google.cloud.chronicle.v1.ListWatchlistsRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of watchlists. Format: |
↳ page_size |
int
Optional. The maximum number of watchlists to return. The service may return fewer than this value. If unspecified, at most 200 watchlists will be returned. The maximum value is 200; values above 200 will be coerced to 200. |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ filter |
string
Optional. Which watchlist to return in aip.dev/160 form. Currently, only the following filters are supported: - |
getParent
Required. The parent, which owns this collection of watchlists.
Format: projects/{project}/locations/{location}/instances/{instance}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The parent, which owns this collection of watchlists.
Format: projects/{project}/locations/{location}/instances/{instance}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Optional. The maximum number of watchlists to return.
The service may return fewer than this value. If unspecified, at most 200 watchlists will be returned. The maximum value is 200; values above 200 will be coerced to 200.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Optional. The maximum number of watchlists to return.
The service may return fewer than this value. If unspecified, at most 200 watchlists will be returned. The maximum value is 200; values above 200 will be coerced to 200.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
Optional. A page token, received from a previous ListWatchlists
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListWatchlists
must match the call that provided the page
token.
Returns | |
---|---|
Type | Description |
string |
setPageToken
Optional. A page token, received from a previous ListWatchlists
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListWatchlists
must match the call that provided the page
token.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Optional. Which watchlist to return in aip.dev/160 form.
Currently, only the following filters are supported:
watchlist_user_preferences.pinned=true
has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])
has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])
Returns | |
---|---|
Type | Description |
string |
setFilter
Optional. Which watchlist to return in aip.dev/160 form.
Currently, only the following filters are supported:
watchlist_user_preferences.pinned=true
has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])
has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The parent, which owns this collection of watchlists.
Format: |
Returns | |
---|---|
Type | Description |
ListWatchlistsRequest |