Chronicle V1 API - Class Google::Cloud::Chronicle::V1::ListWatchlistsRequest (v0.1.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::ListWatchlistsRequest.

Request message for listing watchlists.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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])

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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
  • (::String) —

    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])

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent, which owns this collection of watchlists. Format: projects/{project}/locations/{location}/instances/{instance}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent, which owns this collection of watchlists. Format: projects/{project}/locations/{location}/instances/{instance}
Returns
  • (::String) — Required. The parent, which owns this collection of watchlists. Format: projects/{project}/locations/{location}/instances/{instance}