Package com.google.cloud.chronicle.v1

Interface ListWatchlistsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListWatchlistsRequest, ListWatchlistsRequest.Builder
@Generated public interface ListWatchlistsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The parent, which owns this collection of watchlists.
 Format: `projects/{project}/locations/{location}/instances/{instance}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent, which owns this collection of watchlists.
 Format: `projects/{project}/locations/{location}/instances/{instance}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int 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.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String 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.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      String 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])`
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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])`
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.