saved_searches
Protocol buffer definition for saved_searches
sift/saved_searches/v1/saved_searches.proto
BatchDeleteSavedSearchesRequest
The request for a call to SavedSearchService_BatchDeleteSavedSearches to delete saved searches.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search_ids | string | repeated | Limit of 1000 searches per batch |
BatchDeleteSavedSearchesResponse
The response of a call to SavedSearchService_BatchDeleteSavedSearches.
CreateSavedSearchRequest
The request for a call to SavedSearchService_CreateSavedSearch to create a saved search.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| properties | SavedSearchProperties | ||
| organization_id | string | This field is only required if your user belongs to multiple organizations. |
CreateSavedSearchResponse
The response for a call to SavedSearchService_CreateSavedResponse.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search | SavedSearch |
DeleteSavedSearchRequest
The request for a call to SavedSearchService_DeleteSavedSearch to delete a saved search.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search_id | string |
DeleteSavedSearchResponse
The response of a call to SavedSearchService_DeleteSavedSearch.
GetSavedSearchRequest
The request for a call to SavedSearchService_GetSavedSearch to retrieve a saved search;
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search_id | string |
GetSavedSearchResponse
The response of a call to SavedSearchService_GetSavedSearch.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search | SavedSearch |
ListSavedSearchesRequest
The request for a call to SavedSearchService_ListSavedSearches to retrieve saved searches.
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of saved searches to return. The service may return fewer than this value. If unspecified, at most 50 saved searches will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional. | |
| page_token | string | A page token, received from a previous ListSavedSearches call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSavedSearches must match the call that provided the page token. Optional. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are 'name' and 'saved_search_id'. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. | |
| organization_id | string | This field is only required if your user belongs to multiple organizations. |
ListSavedSearchesResponse
The response of a call to SavedSearchService_ListSavedSearchesResponse.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_searches | SavedSearch | repeated | |
| next_page_token | string |
SavedSearch
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search_id | string | ||
| organization_id | string | ||
| name | string | ||
| properties | SavedSearchProperties | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp |
SavedSearchFilterItem
SavedSearchProperties
| Field | Type | Label | Description |
|---|---|---|---|
| overview_mode | string | ||
| search_term | string | optional | |
| from_date_time | google.protobuf.Timestamp | optional | |
| to_date_time | google.protobuf.Timestamp | optional | |
| asset_items | SavedSearchFilterItem | repeated | |
| user_items | SavedSearchFilterItem | repeated | |
| tag_items | SavedSearchFilterItem | repeated | |
| annotation_items | SavedSearchFilterItem | repeated | |
| run_items | SavedSearchFilterItem | repeated | |
| report_template_items | SavedSearchFilterItem | repeated | |
| show_advanced_filters | bool | optional |
UpdateSavedSearchRequest
The request for a call to SavedSearchService_UpdateSavedSearch to update a saved search.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search | SavedSearch | The saved search to update. | |
| update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are name and properties. |
UpdateSavedSearchResponse
The response of a call to SavedSearchService_UpdateSavedSearch.
| Field | Type | Label | Description |
|---|---|---|---|
| saved_search | SavedSearch |
SavedSearchService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetSavedSearch | GetSavedSearchRequest | GetSavedSearchResponse | Retrieve a saved search. |
| CreateSavedSearch | CreateSavedSearchRequest | CreateSavedSearchResponse | Create a saved search. |
| ListSavedSearches | ListSavedSearchesRequest | ListSavedSearchesResponse | List saved searches. |
| UpdateSavedSearch | UpdateSavedSearchRequest | UpdateSavedSearchResponse | Updates an existing saved search using using the list of fields specified in update_mask. |
| DeleteSavedSearch | DeleteSavedSearchRequest | DeleteSavedSearchResponse | Delete a saved search. |
| BatchDeleteSavedSearches | BatchDeleteSavedSearchesRequest | BatchDeleteSavedSearchesResponse | Batch deletes saved searches. |