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 Summary

Constructors

Constructor and Description
ListNotebooksOptionalParameters()

Method Summary

Modifier and Type	Method and Description
NotebooksApi.ListNotebooksOptionalParameters	authorHandle(String authorHandle) Set authorHandle.
NotebooksApi.ListNotebooksOptionalParameters	count(Long count) Set count.
NotebooksApi.ListNotebooksOptionalParameters	excludeAuthorHandle(String excludeAuthorHandle) Set excludeAuthorHandle.
NotebooksApi.ListNotebooksOptionalParameters	includeCells(Boolean includeCells) Set includeCells.
NotebooksApi.ListNotebooksOptionalParameters	isTemplate(Boolean isTemplate) Set isTemplate.
NotebooksApi.ListNotebooksOptionalParameters	query(String query) Set query.
NotebooksApi.ListNotebooksOptionalParameters	sortDir(String sortDir) Set sortDir.
NotebooksApi.ListNotebooksOptionalParameters	sortField(String sortField) Set sortField.
NotebooksApi.ListNotebooksOptionalParameters	start(Long start) Set start.
NotebooksApi.ListNotebooksOptionalParameters	type(String type) Set type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListNotebooksOptionalParameters

public ListNotebooksOptionalParameters()

Method Detail

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