Package com.datadog.api.client.v1.api

Class NotebooksApi.ListNotebooksOptionalParameters

java.lang.Object
com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters
Enclosing class:
NotebooksApi
public static class NotebooksApi.ListNotebooksOptionalParameters extends Object
Manage optional parameters to listNotebooks.

  • Constructor Details

    • ListNotebooksOptionalParameters

      public ListNotebooksOptionalParameters()

  • Method Details

    • authorHandle

      public NotebooksApi.ListNotebooksOptionalParameters authorHandle(String authorHandle)
      Set authorHandle.
      Parameters:
      authorHandle - Return notebooks created by the given author_handle. (optional)
      Returns:
      ListNotebooksOptionalParameters

    • excludeAuthorHandle

      public NotebooksApi.ListNotebooksOptionalParameters excludeAuthorHandle(String excludeAuthorHandle)
      Set excludeAuthorHandle.
      Parameters:
      excludeAuthorHandle - Return notebooks not created by the given author_handle . (optional)
      Returns:
      ListNotebooksOptionalParameters

    • start

      public NotebooksApi.ListNotebooksOptionalParameters start(Long start)
      Set start.
      Parameters:
      start - The index of the first notebook you want returned. (optional)
      Returns:
      ListNotebooksOptionalParameters

    • count

      public NotebooksApi.ListNotebooksOptionalParameters count(Long count)
      Set count.
      Parameters:
      count - The number of notebooks to be returned. (optional, default to 100)
      Returns:
      ListNotebooksOptionalParameters

    • sortField

      public NotebooksApi.ListNotebooksOptionalParameters sortField(String sortField)
      Set sortField.
      Parameters:
      sortField - Sort by field modified, name, or created . (optional, default to "modified")
      Returns:
      ListNotebooksOptionalParameters

    • sortDir

      public NotebooksApi.ListNotebooksOptionalParameters sortDir(String sortDir)
      Set sortDir.
      Parameters:
      sortDir - Sort by direction asc or desc. (optional, default to "desc")
      Returns:
      ListNotebooksOptionalParameters

    • query

      public NotebooksApi.ListNotebooksOptionalParameters query(String query)
      Set query.
      Parameters:
      query - Return only notebooks with query string in notebook name or author handle. (optional)
      Returns:
      ListNotebooksOptionalParameters

    • includeCells

      public NotebooksApi.ListNotebooksOptionalParameters includeCells(Boolean includeCells)
      Set includeCells.
      Parameters:
      includeCells - Value of false excludes the cells and global time for each notebook. (optional, default to true)
      Returns:
      ListNotebooksOptionalParameters

    • isTemplate

      public NotebooksApi.ListNotebooksOptionalParameters isTemplate(Boolean isTemplate)
      Set isTemplate.
      Parameters:
      isTemplate - True value returns only template notebooks. Default is false (returns only non-template notebooks). (optional, default to false)
      Returns:
      ListNotebooksOptionalParameters

    • type

      public NotebooksApi.ListNotebooksOptionalParameters type(String type)
      Set type.
      Parameters:
      type - If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. (optional)
      Returns:
      ListNotebooksOptionalParameters