Package com.datadog.api.client.v2.api

Class WidgetsApi.SearchWidgetsOptionalParameters

java.lang.Object
com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters
Enclosing class:
WidgetsApi
public static class WidgetsApi.SearchWidgetsOptionalParameters extends Object
Manage optional parameters to searchWidgets.

  • Constructor Details

    • SearchWidgetsOptionalParameters

      public SearchWidgetsOptionalParameters()

  • Method Details

    • filterWidgetType

      public WidgetsApi.SearchWidgetsOptionalParameters filterWidgetType(WidgetType filterWidgetType)
      Set filterWidgetType.
      Parameters:
      filterWidgetType - Filter widgets by widget type. (optional)
      Returns:
      SearchWidgetsOptionalParameters

    • filterCreatorHandle

      public WidgetsApi.SearchWidgetsOptionalParameters filterCreatorHandle(String filterCreatorHandle)
      Set filterCreatorHandle.
      Parameters:
      filterCreatorHandle - Filter widgets by the email handle of the creator. (optional)
      Returns:
      SearchWidgetsOptionalParameters

    • filterIsFavorited

      public WidgetsApi.SearchWidgetsOptionalParameters filterIsFavorited(Boolean filterIsFavorited)
      Set filterIsFavorited.
      Parameters:
      filterIsFavorited - Filter to only widgets favorited by the current user. (optional)
      Returns:
      SearchWidgetsOptionalParameters

    • filterTitle

      public WidgetsApi.SearchWidgetsOptionalParameters filterTitle(String filterTitle)
      Set filterTitle.
      Parameters:
      filterTitle - Filter widgets by title (substring match). (optional)
      Returns:
      SearchWidgetsOptionalParameters

    • filterTags

      public WidgetsApi.SearchWidgetsOptionalParameters filterTags(String filterTags)
      Set filterTags.
      Parameters:
      filterTags - Filter widgets by tags. Format as bracket-delimited CSV, e.g. [tag1,tag2]. (optional)
      Returns:
      SearchWidgetsOptionalParameters

    • sort

      public WidgetsApi.SearchWidgetsOptionalParameters sort(String sort)
      Set sort.
      Parameters:
      sort - Sort field for the results. title, created_at, modified_at — both ascending and descending are supported. Use the bare field name for ascending (e.g. sort=title) or prefix with - for descending (e.g. sort=-modified_at). is_favorited — returns favorites-first ordering (favorited widgets first, then the rest). Direction is fixed; the - prefix is ignored for this field. (optional, default to "-modified_at")
      Returns:
      SearchWidgetsOptionalParameters

    • pageNumber

      public WidgetsApi.SearchWidgetsOptionalParameters pageNumber(Long pageNumber)
      Set pageNumber.
      Parameters:
      pageNumber - Page number for pagination (0-indexed). (optional, default to 0)
      Returns:
      SearchWidgetsOptionalParameters

    • pageSize

      public WidgetsApi.SearchWidgetsOptionalParameters pageSize(Long pageSize)
      Set pageSize.
      Parameters:
      pageSize - Number of widgets per page. (optional, default to 50)
      Returns:
      SearchWidgetsOptionalParameters