com.datadog.api.client.v2.api

Class FormsApi

java.lang.Object

com.datadog.api.client.v2.api.FormsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormsApi.GetFormOptionalParameters Manage optional parameters to getForm.

Constructor Summary

Constructors

Constructor and Description
FormsApi()
FormsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
FormResponse	cloneForm(UUID formId, CloneFormRequest body) Clone a form.
CompletableFuture<FormResponse>	cloneFormAsync(UUID formId, CloneFormRequest body) Clone a form.
ApiResponse<FormResponse>	cloneFormWithHttpInfo(UUID formId, CloneFormRequest body) Clone an existing form.
CompletableFuture<ApiResponse<FormResponse>>	cloneFormWithHttpInfoAsync(UUID formId, CloneFormRequest body) Clone a form.
FormResponse	createAndPublishForm(CreateFormRequest body) Create and publish a form.
CompletableFuture<FormResponse>	createAndPublishFormAsync(CreateFormRequest body) Create and publish a form.
ApiResponse<FormResponse>	createAndPublishFormWithHttpInfo(CreateFormRequest body) Creates a new form and immediately publishes its initial version.
CompletableFuture<ApiResponse<FormResponse>>	createAndPublishFormWithHttpInfoAsync(CreateFormRequest body) Create and publish a form.
FormResponse	createForm(CreateFormRequest body) Create a form.
CompletableFuture<FormResponse>	createFormAsync(CreateFormRequest body) Create a form.
ApiResponse<FormResponse>	createFormWithHttpInfo(CreateFormRequest body) Create a new form.
CompletableFuture<ApiResponse<FormResponse>>	createFormWithHttpInfoAsync(CreateFormRequest body) Create a form.
DeleteFormResponse	deleteForm(UUID formId) Delete a form.
CompletableFuture<DeleteFormResponse>	deleteFormAsync(UUID formId) Delete a form.
ApiResponse<DeleteFormResponse>	deleteFormWithHttpInfo(UUID formId) Delete a form by its ID.
CompletableFuture<ApiResponse<DeleteFormResponse>>	deleteFormWithHttpInfoAsync(UUID formId) Delete a form.
ApiClient	getApiClient() Get the API client.
FormResponse	getForm(UUID formId) Get a form.
FormResponse	getForm(UUID formId, FormsApi.GetFormOptionalParameters parameters) Get a form.
CompletableFuture<FormResponse>	getFormAsync(UUID formId) Get a form.
CompletableFuture<FormResponse>	getFormAsync(UUID formId, FormsApi.GetFormOptionalParameters parameters) Get a form.
ApiResponse<FormResponse>	getFormWithHttpInfo(UUID formId, FormsApi.GetFormOptionalParameters parameters) Get a form definition by its ID.
CompletableFuture<ApiResponse<FormResponse>>	getFormWithHttpInfoAsync(UUID formId, FormsApi.GetFormOptionalParameters parameters) Get a form.
FormsResponse	listForms() List forms.
CompletableFuture<FormsResponse>	listFormsAsync() List forms.
ApiResponse<FormsResponse>	listFormsWithHttpInfo() Get all forms for the authenticated user's organization.
CompletableFuture<ApiResponse<FormsResponse>>	listFormsWithHttpInfoAsync() List forms.
FormPublicationResponse	publishForm(UUID formId, PublishFormRequest body) Publish a form version.
CompletableFuture<FormPublicationResponse>	publishFormAsync(UUID formId, PublishFormRequest body) Publish a form version.
ApiResponse<FormPublicationResponse>	publishFormWithHttpInfo(UUID formId, PublishFormRequest body) Publish a specific version of a form, making it available for submissions.
CompletableFuture<ApiResponse<FormPublicationResponse>>	publishFormWithHttpInfoAsync(UUID formId, PublishFormRequest body) Publish a form version.
void	setApiClient(ApiClient apiClient) Set the API client.
FormResponse	updateForm(UUID formId, UpdateFormRequest body) Update a form.
CompletableFuture<FormResponse>	updateFormAsync(UUID formId, UpdateFormRequest body) Update a form.
ApiResponse<FormResponse>	updateFormWithHttpInfo(UUID formId, UpdateFormRequest body) Update a form's properties such as its name, description, or datastore configuration.
CompletableFuture<ApiResponse<FormResponse>>	updateFormWithHttpInfoAsync(UUID formId, UpdateFormRequest body) Update a form.
FormResponse	upsertAndPublishFormVersion(UUID formId, UpsertAndPublishFormVersionRequest body) Upsert and publish a form version.
CompletableFuture<FormResponse>	upsertAndPublishFormVersionAsync(UUID formId, UpsertAndPublishFormVersionRequest body) Upsert and publish a form version.
ApiResponse<FormResponse>	upsertAndPublishFormVersionWithHttpInfo(UUID formId, UpsertAndPublishFormVersionRequest body) Upsert the latest form version and publish it in a single atomic transaction.
CompletableFuture<ApiResponse<FormResponse>>	upsertAndPublishFormVersionWithHttpInfoAsync(UUID formId, UpsertAndPublishFormVersionRequest body) Upsert and publish a form version.
FormVersionResponse	upsertFormVersion(UUID formId, UpsertFormVersionRequest body) Create or update a form version.
CompletableFuture<FormVersionResponse>	upsertFormVersionAsync(UUID formId, UpsertFormVersionRequest body) Create or update a form version.
ApiResponse<FormVersionResponse>	upsertFormVersionWithHttpInfo(UUID formId, UpsertFormVersionRequest body) Create or update the latest draft version of a form.
CompletableFuture<ApiResponse<FormVersionResponse>>	upsertFormVersionWithHttpInfoAsync(UUID formId, UpsertFormVersionRequest body) Create or update a form version.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormsApi

public FormsApi()

FormsApi

public FormsApi(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

cloneForm

public FormResponse cloneForm(UUID formId,
                              CloneFormRequest body)
                       throws ApiException

Clone a form.

See cloneFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.CloneFormRequest).

Parameters:

formId - The ID of the form to clone. (required)

body - (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

cloneFormAsync

public CompletableFuture<FormResponse> cloneFormAsync(UUID formId,
                                                      CloneFormRequest body)

Clone a form.

See cloneFormWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.CloneFormRequest).

Parameters:

formId - The ID of the form to clone. (required)

body - (required)

Returns:

CompletableFuture<FormResponse>

cloneFormWithHttpInfo

public ApiResponse<FormResponse> cloneFormWithHttpInfo(UUID formId,
                                                       CloneFormRequest body)
                                                throws ApiException

Clone an existing form. The clone is created in draft mode using the source form's latest version.

Parameters:

formId - The ID of the form to clone. (required)

body - (required)

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

cloneFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> cloneFormWithHttpInfoAsync(UUID formId,
                                                                               CloneFormRequest body)

Clone a form.

See cloneFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.CloneFormRequest).

Parameters:

formId - The ID of the form to clone. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<FormResponse>>

createAndPublishForm

public FormResponse createAndPublishForm(CreateFormRequest body)
                                  throws ApiException

Create and publish a form.

See createAndPublishFormWithHttpInfo(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

createAndPublishFormAsync

public CompletableFuture<FormResponse> createAndPublishFormAsync(CreateFormRequest body)

Create and publish a form.

See createAndPublishFormWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<FormResponse>

createAndPublishFormWithHttpInfo

public ApiResponse<FormResponse> createAndPublishFormWithHttpInfo(CreateFormRequest body)
                                                           throws ApiException

Creates a new form and immediately publishes its initial version. This also creates a new datastore for form responses and links it to the form.

Parameters:

body - (required)

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
429	Too many requests	-

createAndPublishFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> createAndPublishFormWithHttpInfoAsync(CreateFormRequest body)

Create and publish a form.

See createAndPublishFormWithHttpInfo(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<FormResponse>>

createForm

public FormResponse createForm(CreateFormRequest body)
                        throws ApiException

Create a form.

See createFormWithHttpInfo(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

createFormAsync

public CompletableFuture<FormResponse> createFormAsync(CreateFormRequest body)

Create a form.

See createFormWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<FormResponse>

createFormWithHttpInfo

public ApiResponse<FormResponse> createFormWithHttpInfo(CreateFormRequest body)
                                                 throws ApiException

Create a new form. The form is created in draft mode and must be published before it can be used. This also creates a new datastore for form responses and links it to the form.

Parameters:

body - (required)

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
429	Too many requests	-

createFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> createFormWithHttpInfoAsync(CreateFormRequest body)

Create a form.

See createFormWithHttpInfo(com.datadog.api.client.v2.model.CreateFormRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<FormResponse>>

deleteForm

public DeleteFormResponse deleteForm(UUID formId)
                              throws ApiException

Delete a form.

See deleteFormWithHttpInfo(java.util.UUID).

Parameters:

formId - The ID of the form. (required)

Returns:

DeleteFormResponse

Throws:

ApiException - if fails to make API call

deleteFormAsync

public CompletableFuture<DeleteFormResponse> deleteFormAsync(UUID formId)

Delete a form.

See deleteFormWithHttpInfoAsync(java.util.UUID).

Parameters:

formId - The ID of the form. (required)

Returns:

CompletableFuture<DeleteFormResponse>

deleteFormWithHttpInfo

public ApiResponse<DeleteFormResponse> deleteFormWithHttpInfo(UUID formId)
                                                       throws ApiException

Delete a form by its ID. This will also try to delete the associated datastore.

Parameters:

formId - The ID of the form. (required)

Returns:

ApiResponse<DeleteFormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
429	Too many requests	-

deleteFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeleteFormResponse>> deleteFormWithHttpInfoAsync(UUID formId)

Delete a form.

See deleteFormWithHttpInfo(java.util.UUID).

Parameters:

formId - The ID of the form. (required)

Returns:

CompletableFuture<ApiResponse<DeleteFormResponse>>

getForm

public FormResponse getForm(UUID formId)
                     throws ApiException

Get a form.

See getFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.FormsApi.GetFormOptionalParameters).

Parameters:

formId - The ID of the form. (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

getFormAsync

public CompletableFuture<FormResponse> getFormAsync(UUID formId)

Get a form.

See getFormWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.FormsApi.GetFormOptionalParameters).

Parameters:

formId - The ID of the form. (required)

Returns:

CompletableFuture<FormResponse>

getForm

public FormResponse getForm(UUID formId,
                            FormsApi.GetFormOptionalParameters parameters)
                     throws ApiException

Get a form.

See getFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.FormsApi.GetFormOptionalParameters).

Parameters:

formId - The ID of the form. (required)

parameters - Optional parameters for the request.

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

getFormAsync

public CompletableFuture<FormResponse> getFormAsync(UUID formId,
                                                    FormsApi.GetFormOptionalParameters parameters)

Get a form.

See getFormWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.FormsApi.GetFormOptionalParameters).

Parameters:

formId - The ID of the form. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<FormResponse>

getFormWithHttpInfo

public ApiResponse<FormResponse> getFormWithHttpInfo(UUID formId,
                                                     FormsApi.GetFormOptionalParameters parameters)
                                              throws ApiException

Get a form definition by its ID.

Parameters:

formId - The ID of the form. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

getFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> getFormWithHttpInfoAsync(UUID formId,
                                                                             FormsApi.GetFormOptionalParameters parameters)

Get a form.

See getFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.FormsApi.GetFormOptionalParameters).

Parameters:

formId - The ID of the form. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<FormResponse>>

listForms

public FormsResponse listForms()
                        throws ApiException

List forms.

See listFormsWithHttpInfo().

Returns:

FormsResponse

Throws:

ApiException - if fails to make API call

listFormsAsync

public CompletableFuture<FormsResponse> listFormsAsync()

List forms.

See listFormsWithHttpInfoAsync().

Returns:

CompletableFuture<FormsResponse>

listFormsWithHttpInfo

public ApiResponse<FormsResponse> listFormsWithHttpInfo()
                                                 throws ApiException

Get all forms for the authenticated user's organization.

Returns:

ApiResponse<FormsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
429	Too many requests	-

listFormsWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormsResponse>> listFormsWithHttpInfoAsync()

List forms.

See listFormsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<FormsResponse>>

publishForm

public FormPublicationResponse publishForm(UUID formId,
                                           PublishFormRequest body)
                                    throws ApiException

Publish a form version.

See publishFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.PublishFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

FormPublicationResponse

Throws:

ApiException - if fails to make API call

publishFormAsync

public CompletableFuture<FormPublicationResponse> publishFormAsync(UUID formId,
                                                                   PublishFormRequest body)

Publish a form version.

See publishFormWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.PublishFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<FormPublicationResponse>

publishFormWithHttpInfo

public ApiResponse<FormPublicationResponse> publishFormWithHttpInfo(UUID formId,
                                                                    PublishFormRequest body)
                                                             throws ApiException

Publish a specific version of a form, making it available for submissions.

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

ApiResponse<FormPublicationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

publishFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormPublicationResponse>> publishFormWithHttpInfoAsync(UUID formId,
                                                                                            PublishFormRequest body)

Publish a form version.

See publishFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.PublishFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<FormPublicationResponse>>

updateForm

public FormResponse updateForm(UUID formId,
                               UpdateFormRequest body)
                        throws ApiException

Update a form.

See updateFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpdateFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

updateFormAsync

public CompletableFuture<FormResponse> updateFormAsync(UUID formId,
                                                       UpdateFormRequest body)

Update a form.

See updateFormWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.UpdateFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<FormResponse>

updateFormWithHttpInfo

public ApiResponse<FormResponse> updateFormWithHttpInfo(UUID formId,
                                                        UpdateFormRequest body)
                                                 throws ApiException

Update a form's properties such as its name, description, or datastore configuration.

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

updateFormWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> updateFormWithHttpInfoAsync(UUID formId,
                                                                                UpdateFormRequest body)

Update a form.

See updateFormWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpdateFormRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<FormResponse>>

upsertAndPublishFormVersion

public FormResponse upsertAndPublishFormVersion(UUID formId,
                                                UpsertAndPublishFormVersionRequest body)
                                         throws ApiException

Upsert and publish a form version.

See upsertAndPublishFormVersionWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpsertAndPublishFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

FormResponse

Throws:

ApiException - if fails to make API call

upsertAndPublishFormVersionAsync

public CompletableFuture<FormResponse> upsertAndPublishFormVersionAsync(UUID formId,
                                                                        UpsertAndPublishFormVersionRequest body)

Upsert and publish a form version.

See upsertAndPublishFormVersionWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.UpsertAndPublishFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<FormResponse>

upsertAndPublishFormVersionWithHttpInfo

public ApiResponse<FormResponse> upsertAndPublishFormVersionWithHttpInfo(UUID formId,
                                                                         UpsertAndPublishFormVersionRequest body)
                                                                  throws ApiException

Upsert the latest form version and publish it in a single atomic transaction.

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

ApiResponse<FormResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

upsertAndPublishFormVersionWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormResponse>> upsertAndPublishFormVersionWithHttpInfoAsync(UUID formId,
                                                                                                 UpsertAndPublishFormVersionRequest body)

Upsert and publish a form version.

See upsertAndPublishFormVersionWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpsertAndPublishFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<FormResponse>>

upsertFormVersion

public FormVersionResponse upsertFormVersion(UUID formId,
                                             UpsertFormVersionRequest body)
                                      throws ApiException

Create or update a form version.

See upsertFormVersionWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpsertFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

FormVersionResponse

Throws:

ApiException - if fails to make API call

upsertFormVersionAsync

public CompletableFuture<FormVersionResponse> upsertFormVersionAsync(UUID formId,
                                                                     UpsertFormVersionRequest body)

Create or update a form version.

See upsertFormVersionWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.UpsertFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<FormVersionResponse>

upsertFormVersionWithHttpInfo

public ApiResponse<FormVersionResponse> upsertFormVersionWithHttpInfo(UUID formId,
                                                                      UpsertFormVersionRequest body)
                                                               throws ApiException

Create or update the latest draft version of a form. The upsert_params field controls optimistic concurrency behavior.

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

ApiResponse<FormVersionResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
429	Too many requests	-

upsertFormVersionWithHttpInfoAsync

public CompletableFuture<ApiResponse<FormVersionResponse>> upsertFormVersionWithHttpInfoAsync(UUID formId,
                                                                                              UpsertFormVersionRequest body)

Create or update a form version.

See upsertFormVersionWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpsertFormVersionRequest).

Parameters:

formId - The ID of the form. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<FormVersionResponse>>