com.datadog.api.client.v1.api

Class NotebooksApi

java.lang.Object

com.datadog.api.client.v1.api.NotebooksApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class NotebooksApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotebooksApi.ListNotebooksOptionalParameters Manage optional parameters to listNotebooks.

Constructor Summary

Constructors

Constructor and Description
NotebooksApi()
NotebooksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
NotebookResponse	createNotebook(NotebookCreateRequest body) Create a notebook.
CompletableFuture<NotebookResponse>	createNotebookAsync(NotebookCreateRequest body) Create a notebook.
ApiResponse<NotebookResponse>	createNotebookWithHttpInfo(NotebookCreateRequest body) Create a notebook using the specified options.
CompletableFuture<ApiResponse<NotebookResponse>>	createNotebookWithHttpInfoAsync(NotebookCreateRequest body) Create a notebook.
void	deleteNotebook(Long notebookId) Delete a notebook.
CompletableFuture<Void>	deleteNotebookAsync(Long notebookId) Delete a notebook.
ApiResponse<Void>	deleteNotebookWithHttpInfo(Long notebookId) Delete a notebook using the specified ID.
CompletableFuture<ApiResponse<Void>>	deleteNotebookWithHttpInfoAsync(Long notebookId) Delete a notebook.
ApiClient	getApiClient() Get the API client.
NotebookResponse	getNotebook(Long notebookId) Get a notebook.
CompletableFuture<NotebookResponse>	getNotebookAsync(Long notebookId) Get a notebook.
ApiResponse<NotebookResponse>	getNotebookWithHttpInfo(Long notebookId) Get a notebook using the specified notebook ID.
CompletableFuture<ApiResponse<NotebookResponse>>	getNotebookWithHttpInfoAsync(Long notebookId) Get a notebook.
NotebooksResponse	listNotebooks() Get all notebooks.
NotebooksResponse	listNotebooks(NotebooksApi.ListNotebooksOptionalParameters parameters) Get all notebooks.
CompletableFuture<NotebooksResponse>	listNotebooksAsync() Get all notebooks.
CompletableFuture<NotebooksResponse>	listNotebooksAsync(NotebooksApi.ListNotebooksOptionalParameters parameters) Get all notebooks.
ApiResponse<NotebooksResponse>	listNotebooksWithHttpInfo(NotebooksApi.ListNotebooksOptionalParameters parameters) Get all notebooks.
CompletableFuture<ApiResponse<NotebooksResponse>>	listNotebooksWithHttpInfoAsync(NotebooksApi.ListNotebooksOptionalParameters parameters) Get all notebooks.
PaginationIterable<NotebooksResponseData>	listNotebooksWithPagination() Get all notebooks.
PaginationIterable<NotebooksResponseData>	listNotebooksWithPagination(NotebooksApi.ListNotebooksOptionalParameters parameters) Get all notebooks.
void	setApiClient(ApiClient apiClient) Set the API client.
NotebookResponse	updateNotebook(Long notebookId, NotebookUpdateRequest body) Update a notebook.
CompletableFuture<NotebookResponse>	updateNotebookAsync(Long notebookId, NotebookUpdateRequest body) Update a notebook.
ApiResponse<NotebookResponse>	updateNotebookWithHttpInfo(Long notebookId, NotebookUpdateRequest body) Update a notebook using the specified ID.
CompletableFuture<ApiResponse<NotebookResponse>>	updateNotebookWithHttpInfoAsync(Long notebookId, NotebookUpdateRequest body) Update a notebook.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotebooksApi

public NotebooksApi()

NotebooksApi

public NotebooksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createNotebook

public NotebookResponse createNotebook(NotebookCreateRequest body)
                                throws ApiException

Create a notebook.

See createNotebookWithHttpInfo(com.datadog.api.client.v1.model.NotebookCreateRequest).

Parameters:

body - The JSON description of the notebook you want to create. (required)

Returns:

NotebookResponse

Throws:

ApiException - if fails to make API call

createNotebookAsync

public CompletableFuture<NotebookResponse> createNotebookAsync(NotebookCreateRequest body)

Create a notebook.

See createNotebookWithHttpInfoAsync(com.datadog.api.client.v1.model.NotebookCreateRequest).

Parameters:

body - The JSON description of the notebook you want to create. (required)

Returns:

CompletableFuture<NotebookResponse>

createNotebookWithHttpInfo

public ApiResponse<NotebookResponse> createNotebookWithHttpInfo(NotebookCreateRequest body)
                                                         throws ApiException

Create a notebook using the specified options.

Parameters:

body - The JSON description of the notebook you want to create. (required)

Returns:

ApiResponse<NotebookResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
429	Too many requests	-

createNotebookWithHttpInfoAsync

public CompletableFuture<ApiResponse<NotebookResponse>> createNotebookWithHttpInfoAsync(NotebookCreateRequest body)

Create a notebook.

See createNotebookWithHttpInfo(com.datadog.api.client.v1.model.NotebookCreateRequest).

Parameters:

body - The JSON description of the notebook you want to create. (required)

Returns:

CompletableFuture<ApiResponse<NotebookResponse>>

deleteNotebook

public void deleteNotebook(Long notebookId)
                    throws ApiException

Delete a notebook.

See deleteNotebookWithHttpInfo(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Throws:

ApiException - if fails to make API call

deleteNotebookAsync

public CompletableFuture<Void> deleteNotebookAsync(Long notebookId)

Delete a notebook.

See deleteNotebookWithHttpInfoAsync(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

CompletableFuture

deleteNotebookWithHttpInfo

public ApiResponse<Void> deleteNotebookWithHttpInfo(Long notebookId)
                                             throws ApiException

Delete a notebook using the specified ID.

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
400	Bad Request	-
403	Authentication Error	-
404	Not Found	-
429	Too many requests	-

deleteNotebookWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteNotebookWithHttpInfoAsync(Long notebookId)

Delete a notebook.

See deleteNotebookWithHttpInfo(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getNotebook

public NotebookResponse getNotebook(Long notebookId)
                             throws ApiException

Get a notebook.

See getNotebookWithHttpInfo(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

NotebookResponse

Throws:

ApiException - if fails to make API call

getNotebookAsync

public CompletableFuture<NotebookResponse> getNotebookAsync(Long notebookId)

Get a notebook.

See getNotebookWithHttpInfoAsync(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

CompletableFuture<NotebookResponse>

getNotebookWithHttpInfo

public ApiResponse<NotebookResponse> getNotebookWithHttpInfo(Long notebookId)
                                                      throws ApiException

Get a notebook using the specified notebook ID.

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

ApiResponse<NotebookResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
404	Not Found	-
429	Too many requests	-

getNotebookWithHttpInfoAsync

public CompletableFuture<ApiResponse<NotebookResponse>> getNotebookWithHttpInfoAsync(Long notebookId)

Get a notebook.

See getNotebookWithHttpInfo(java.lang.Long).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

Returns:

CompletableFuture<ApiResponse<NotebookResponse>>

listNotebooks

public NotebooksResponse listNotebooks()
                                throws ApiException

Get all notebooks.

See listNotebooksWithHttpInfo(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Returns:

NotebooksResponse

Throws:

ApiException - if fails to make API call

listNotebooksAsync

public CompletableFuture<NotebooksResponse> listNotebooksAsync()

Get all notebooks.

See listNotebooksWithHttpInfoAsync(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Returns:

CompletableFuture<NotebooksResponse>

listNotebooks

public NotebooksResponse listNotebooks(NotebooksApi.ListNotebooksOptionalParameters parameters)
                                throws ApiException

Get all notebooks.

See listNotebooksWithHttpInfo(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

NotebooksResponse

Throws:

ApiException - if fails to make API call

listNotebooksAsync

public CompletableFuture<NotebooksResponse> listNotebooksAsync(NotebooksApi.ListNotebooksOptionalParameters parameters)

Get all notebooks.

See listNotebooksWithHttpInfoAsync(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<NotebooksResponse>

listNotebooksWithPagination

public PaginationIterable<NotebooksResponseData> listNotebooksWithPagination()

Get all notebooks.

See listNotebooksWithHttpInfo(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Returns:

PaginationIterable<NotebooksResponseData>

listNotebooksWithPagination

public PaginationIterable<NotebooksResponseData> listNotebooksWithPagination(NotebooksApi.ListNotebooksOptionalParameters parameters)

Get all notebooks.

See listNotebooksWithHttpInfo(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Returns:

NotebooksResponse

listNotebooksWithHttpInfo

public ApiResponse<NotebooksResponse> listNotebooksWithHttpInfo(NotebooksApi.ListNotebooksOptionalParameters parameters)
                                                         throws ApiException

Get all notebooks. This can also be used to search for notebooks with a particular query in the notebook name or author handle.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<NotebooksResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
429	Too many requests	-

listNotebooksWithHttpInfoAsync

public CompletableFuture<ApiResponse<NotebooksResponse>> listNotebooksWithHttpInfoAsync(NotebooksApi.ListNotebooksOptionalParameters parameters)

Get all notebooks.

See listNotebooksWithHttpInfo(com.datadog.api.client.v1.api.NotebooksApi.ListNotebooksOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<NotebooksResponse>>

updateNotebook

public NotebookResponse updateNotebook(Long notebookId,
                                       NotebookUpdateRequest body)
                                throws ApiException

Update a notebook.

See updateNotebookWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.NotebookUpdateRequest).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

body - Update notebook request body. (required)

Returns:

NotebookResponse

Throws:

ApiException - if fails to make API call

updateNotebookAsync

public CompletableFuture<NotebookResponse> updateNotebookAsync(Long notebookId,
                                                               NotebookUpdateRequest body)

Update a notebook.

See updateNotebookWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.model.NotebookUpdateRequest).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

body - Update notebook request body. (required)

Returns:

CompletableFuture<NotebookResponse>

updateNotebookWithHttpInfo

public ApiResponse<NotebookResponse> updateNotebookWithHttpInfo(Long notebookId,
                                                                NotebookUpdateRequest body)
                                                         throws ApiException

Update a notebook using the specified ID.

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

body - Update notebook request body. (required)

Returns:

ApiResponse<NotebookResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
404	Not Found	-
409	Conflict	-
429	Too many requests	-

updateNotebookWithHttpInfoAsync

public CompletableFuture<ApiResponse<NotebookResponse>> updateNotebookWithHttpInfoAsync(Long notebookId,
                                                                                        NotebookUpdateRequest body)

Update a notebook.

See updateNotebookWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.model.NotebookUpdateRequest).

Parameters:

notebookId - Unique ID, assigned when you create the notebook. (required)

body - Update notebook request body. (required)

Returns:

CompletableFuture<ApiResponse<NotebookResponse>>