com.datadog.api.client.v2.api

Class SyntheticsApi

java.lang.Object

com.datadog.api.client.v2.api.SyntheticsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SyntheticsApi.SearchSuitesOptionalParameters Manage optional parameters to searchSuites.

Constructor Summary

Constructors

Constructor and Description
SyntheticsApi()
SyntheticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SyntheticsSuiteResponse	createSyntheticsSuite(SuiteCreateEditRequest body) Synthetics: Create a test suite.
CompletableFuture<SyntheticsSuiteResponse>	createSyntheticsSuiteAsync(SuiteCreateEditRequest body) Synthetics: Create a test suite.
ApiResponse<SyntheticsSuiteResponse>	createSyntheticsSuiteWithHttpInfo(SuiteCreateEditRequest body)
CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>	createSyntheticsSuiteWithHttpInfoAsync(SuiteCreateEditRequest body) Synthetics: Create a test suite.
DeletedSuitesResponse	deleteSyntheticsSuites(DeletedSuitesRequestDeleteRequest body) Synthetics: Bulk delete suites.
CompletableFuture<DeletedSuitesResponse>	deleteSyntheticsSuitesAsync(DeletedSuitesRequestDeleteRequest body) Synthetics: Bulk delete suites.
ApiResponse<DeletedSuitesResponse>	deleteSyntheticsSuitesWithHttpInfo(DeletedSuitesRequestDeleteRequest body)
CompletableFuture<ApiResponse<DeletedSuitesResponse>>	deleteSyntheticsSuitesWithHttpInfoAsync(DeletedSuitesRequestDeleteRequest body) Synthetics: Bulk delete suites.
SyntheticsSuiteResponse	editSyntheticsSuite(String publicId, SuiteCreateEditRequest body) Synthetics: Edit a test suite.
CompletableFuture<SyntheticsSuiteResponse>	editSyntheticsSuiteAsync(String publicId, SuiteCreateEditRequest body) Synthetics: Edit a test suite.
ApiResponse<SyntheticsSuiteResponse>	editSyntheticsSuiteWithHttpInfo(String publicId, SuiteCreateEditRequest body)
CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>	editSyntheticsSuiteWithHttpInfoAsync(String publicId, SuiteCreateEditRequest body) Synthetics: Edit a test suite.
ApiClient	getApiClient() Get the API client.
OnDemandConcurrencyCapResponse	getOnDemandConcurrencyCap() Get the on-demand concurrency cap.
CompletableFuture<OnDemandConcurrencyCapResponse>	getOnDemandConcurrencyCapAsync() Get the on-demand concurrency cap.
ApiResponse<OnDemandConcurrencyCapResponse>	getOnDemandConcurrencyCapWithHttpInfo() Get the on-demand concurrency cap.
CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>>	getOnDemandConcurrencyCapWithHttpInfoAsync() Get the on-demand concurrency cap.
SyntheticsSuiteResponse	getSyntheticsSuite(String publicId) Synthetics: Get a suite.
CompletableFuture<SyntheticsSuiteResponse>	getSyntheticsSuiteAsync(String publicId) Synthetics: Get a suite.
ApiResponse<SyntheticsSuiteResponse>	getSyntheticsSuiteWithHttpInfo(String publicId)
CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>	getSyntheticsSuiteWithHttpInfoAsync(String publicId) Synthetics: Get a suite.
GlobalVariableResponse	patchGlobalVariable(String variableId, GlobalVariableJsonPatchRequest body) Patch a global variable.
CompletableFuture<GlobalVariableResponse>	patchGlobalVariableAsync(String variableId, GlobalVariableJsonPatchRequest body) Patch a global variable.
ApiResponse<GlobalVariableResponse>	patchGlobalVariableWithHttpInfo(String variableId, GlobalVariableJsonPatchRequest body) Patch a global variable using JSON Patch (RFC 6902).
CompletableFuture<ApiResponse<GlobalVariableResponse>>	patchGlobalVariableWithHttpInfoAsync(String variableId, GlobalVariableJsonPatchRequest body) Patch a global variable.
SyntheticsSuiteSearchResponse	searchSuites() Search Synthetics suites.
SyntheticsSuiteSearchResponse	searchSuites(SyntheticsApi.SearchSuitesOptionalParameters parameters) Search Synthetics suites.
CompletableFuture<SyntheticsSuiteSearchResponse>	searchSuitesAsync() Search Synthetics suites.
CompletableFuture<SyntheticsSuiteSearchResponse>	searchSuitesAsync(SyntheticsApi.SearchSuitesOptionalParameters parameters) Search Synthetics suites.
ApiResponse<SyntheticsSuiteSearchResponse>	searchSuitesWithHttpInfo(SyntheticsApi.SearchSuitesOptionalParameters parameters) Search for Synthetics suites.
CompletableFuture<ApiResponse<SyntheticsSuiteSearchResponse>>	searchSuitesWithHttpInfoAsync(SyntheticsApi.SearchSuitesOptionalParameters parameters) Search Synthetics suites.
void	setApiClient(ApiClient apiClient) Set the API client.
OnDemandConcurrencyCapResponse	setOnDemandConcurrencyCap(OnDemandConcurrencyCapAttributes body) Save new value for on-demand concurrency cap.
CompletableFuture<OnDemandConcurrencyCapResponse>	setOnDemandConcurrencyCapAsync(OnDemandConcurrencyCapAttributes body) Save new value for on-demand concurrency cap.
ApiResponse<OnDemandConcurrencyCapResponse>	setOnDemandConcurrencyCapWithHttpInfo(OnDemandConcurrencyCapAttributes body) Save new value for on-demand concurrency cap.
CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>>	setOnDemandConcurrencyCapWithHttpInfoAsync(OnDemandConcurrencyCapAttributes body) Save new value for on-demand concurrency cap.

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntheticsApi

public SyntheticsApi()

SyntheticsApi

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

createSyntheticsSuite

public SyntheticsSuiteResponse createSyntheticsSuite(SuiteCreateEditRequest body)
                                              throws ApiException

Synthetics: Create a test suite.

See createSyntheticsSuiteWithHttpInfo(com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

body - (required)

Returns:

SyntheticsSuiteResponse

Throws:

ApiException - if fails to make API call

createSyntheticsSuiteAsync

public CompletableFuture<SyntheticsSuiteResponse> createSyntheticsSuiteAsync(SuiteCreateEditRequest body)

Synthetics: Create a test suite.

See createSyntheticsSuiteWithHttpInfoAsync(com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<SyntheticsSuiteResponse>

createSyntheticsSuiteWithHttpInfo

public ApiResponse<SyntheticsSuiteResponse> createSyntheticsSuiteWithHttpInfo(SuiteCreateEditRequest body)
                                                                       throws ApiException

Parameters:

body - (required)

Returns:

ApiResponse<SyntheticsSuiteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	API error response.	-
429	Too many requests	-

createSyntheticsSuiteWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsSuiteResponse>> createSyntheticsSuiteWithHttpInfoAsync(SuiteCreateEditRequest body)

Synthetics: Create a test suite.

See createSyntheticsSuiteWithHttpInfo(com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>

deleteSyntheticsSuites

public DeletedSuitesResponse deleteSyntheticsSuites(DeletedSuitesRequestDeleteRequest body)
                                             throws ApiException

Synthetics: Bulk delete suites.

See deleteSyntheticsSuitesWithHttpInfo(com.datadog.api.client.v2.model.DeletedSuitesRequestDeleteRequest).

Parameters:

body - (required)

Returns:

DeletedSuitesResponse

Throws:

ApiException - if fails to make API call

deleteSyntheticsSuitesAsync

public CompletableFuture<DeletedSuitesResponse> deleteSyntheticsSuitesAsync(DeletedSuitesRequestDeleteRequest body)

Synthetics: Bulk delete suites.

See deleteSyntheticsSuitesWithHttpInfoAsync(com.datadog.api.client.v2.model.DeletedSuitesRequestDeleteRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DeletedSuitesResponse>

deleteSyntheticsSuitesWithHttpInfo

public ApiResponse<DeletedSuitesResponse> deleteSyntheticsSuitesWithHttpInfo(DeletedSuitesRequestDeleteRequest body)
                                                                      throws ApiException

Parameters:

body - (required)

Returns:

ApiResponse<DeletedSuitesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	API error response.	-
429	Too many requests	-

deleteSyntheticsSuitesWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeletedSuitesResponse>> deleteSyntheticsSuitesWithHttpInfoAsync(DeletedSuitesRequestDeleteRequest body)

Synthetics: Bulk delete suites.

See deleteSyntheticsSuitesWithHttpInfo(com.datadog.api.client.v2.model.DeletedSuitesRequestDeleteRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DeletedSuitesResponse>>

editSyntheticsSuite

public SyntheticsSuiteResponse editSyntheticsSuite(String publicId,
                                                   SuiteCreateEditRequest body)
                                            throws ApiException

Synthetics: Edit a test suite.

See editSyntheticsSuiteWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

publicId - The public ID of the suite to edit. (required)

body - New suite details to be saved. (required)

Returns:

SyntheticsSuiteResponse

Throws:

ApiException - if fails to make API call

editSyntheticsSuiteAsync

public CompletableFuture<SyntheticsSuiteResponse> editSyntheticsSuiteAsync(String publicId,
                                                                           SuiteCreateEditRequest body)

Synthetics: Edit a test suite.

See editSyntheticsSuiteWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

publicId - The public ID of the suite to edit. (required)

body - New suite details to be saved. (required)

Returns:

CompletableFuture<SyntheticsSuiteResponse>

editSyntheticsSuiteWithHttpInfo

public ApiResponse<SyntheticsSuiteResponse> editSyntheticsSuiteWithHttpInfo(String publicId,
                                                                            SuiteCreateEditRequest body)
                                                                     throws ApiException

Parameters:

publicId - The public ID of the suite to edit. (required)

body - New suite details to be saved. (required)

Returns:

ApiResponse<SyntheticsSuiteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	API error response.	-
429	Too many requests	-

editSyntheticsSuiteWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsSuiteResponse>> editSyntheticsSuiteWithHttpInfoAsync(String publicId,
                                                                                                    SuiteCreateEditRequest body)

Synthetics: Edit a test suite.

See editSyntheticsSuiteWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SuiteCreateEditRequest).

Parameters:

publicId - The public ID of the suite to edit. (required)

body - New suite details to be saved. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>

getOnDemandConcurrencyCap

public OnDemandConcurrencyCapResponse getOnDemandConcurrencyCap()
                                                         throws ApiException

Get the on-demand concurrency cap.

See getOnDemandConcurrencyCapWithHttpInfo().

Returns:

OnDemandConcurrencyCapResponse

Throws:

ApiException - if fails to make API call

getOnDemandConcurrencyCapAsync

public CompletableFuture<OnDemandConcurrencyCapResponse> getOnDemandConcurrencyCapAsync()

Get the on-demand concurrency cap.

See getOnDemandConcurrencyCapWithHttpInfoAsync().

Returns:

CompletableFuture<OnDemandConcurrencyCapResponse>

getOnDemandConcurrencyCapWithHttpInfo

public ApiResponse<OnDemandConcurrencyCapResponse> getOnDemandConcurrencyCapWithHttpInfo()
                                                                                  throws ApiException

Get the on-demand concurrency cap.

Returns:

ApiResponse<OnDemandConcurrencyCapResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
429	Too many requests	-

getOnDemandConcurrencyCapWithHttpInfoAsync

public CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>> getOnDemandConcurrencyCapWithHttpInfoAsync()

Get the on-demand concurrency cap.

See getOnDemandConcurrencyCapWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>>

getSyntheticsSuite

public SyntheticsSuiteResponse getSyntheticsSuite(String publicId)
                                           throws ApiException

Synthetics: Get a suite.

See getSyntheticsSuiteWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the suite to get details from. (required)

Returns:

SyntheticsSuiteResponse

Throws:

ApiException - if fails to make API call

getSyntheticsSuiteAsync

public CompletableFuture<SyntheticsSuiteResponse> getSyntheticsSuiteAsync(String publicId)

Synthetics: Get a suite.

See getSyntheticsSuiteWithHttpInfoAsync(java.lang.String).

Parameters:

publicId - The public ID of the suite to get details from. (required)

Returns:

CompletableFuture<SyntheticsSuiteResponse>

getSyntheticsSuiteWithHttpInfo

public ApiResponse<SyntheticsSuiteResponse> getSyntheticsSuiteWithHttpInfo(String publicId)
                                                                    throws ApiException

Parameters:

publicId - The public ID of the suite to get details from. (required)

Returns:

ApiResponse<SyntheticsSuiteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
404	API error response.	-
429	Too many requests	-

getSyntheticsSuiteWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsSuiteResponse>> getSyntheticsSuiteWithHttpInfoAsync(String publicId)

Synthetics: Get a suite.

See getSyntheticsSuiteWithHttpInfo(java.lang.String).

Parameters:

publicId - The public ID of the suite to get details from. (required)

Returns:

CompletableFuture<ApiResponse<SyntheticsSuiteResponse>>

patchGlobalVariable

public GlobalVariableResponse patchGlobalVariable(String variableId,
                                                  GlobalVariableJsonPatchRequest body)
                                           throws ApiException

Patch a global variable.

See patchGlobalVariableWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.GlobalVariableJsonPatchRequest).

Parameters:

variableId - The ID of the global variable. (required)

body - JSON Patch document with operations to apply. (required)

Returns:

GlobalVariableResponse

Throws:

ApiException - if fails to make API call

patchGlobalVariableAsync

public CompletableFuture<GlobalVariableResponse> patchGlobalVariableAsync(String variableId,
                                                                          GlobalVariableJsonPatchRequest body)

Patch a global variable.

See patchGlobalVariableWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.GlobalVariableJsonPatchRequest).

Parameters:

variableId - The ID of the global variable. (required)

body - JSON Patch document with operations to apply. (required)

Returns:

CompletableFuture<GlobalVariableResponse>

patchGlobalVariableWithHttpInfo

public ApiResponse<GlobalVariableResponse> patchGlobalVariableWithHttpInfo(String variableId,
                                                                           GlobalVariableJsonPatchRequest body)
                                                                    throws ApiException

Patch a global variable using JSON Patch (RFC 6902). This endpoint allows partial updates to a global variable by specifying only the fields to modify.

Common operations include: - Replace field values: {"op": "replace", "path": "/name", "value": "new_name"} - Update nested values: {"op": "replace", "path": "/value/value", "value": "new_value"} - Add/update tags: {"op": "add", "path": "/tags/-", "value": "new_tag"} - Remove fields: {"op": "remove", "path": "/description"}

Parameters:

variableId - The ID of the global variable. (required)

body - JSON Patch document with operations to apply. (required)

Returns:

ApiResponse<GlobalVariableResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

patchGlobalVariableWithHttpInfoAsync

public CompletableFuture<ApiResponse<GlobalVariableResponse>> patchGlobalVariableWithHttpInfoAsync(String variableId,
                                                                                                   GlobalVariableJsonPatchRequest body)

Patch a global variable.

See patchGlobalVariableWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.GlobalVariableJsonPatchRequest).

Parameters:

variableId - The ID of the global variable. (required)

body - JSON Patch document with operations to apply. (required)

Returns:

CompletableFuture<ApiResponse<GlobalVariableResponse>>

searchSuites

public SyntheticsSuiteSearchResponse searchSuites()
                                           throws ApiException

Search Synthetics suites.

See searchSuitesWithHttpInfo(com.datadog.api.client.v2.api.SyntheticsApi.SearchSuitesOptionalParameters).

Returns:

SyntheticsSuiteSearchResponse

Throws:

ApiException - if fails to make API call

searchSuitesAsync

public CompletableFuture<SyntheticsSuiteSearchResponse> searchSuitesAsync()

Search Synthetics suites.

See searchSuitesWithHttpInfoAsync(com.datadog.api.client.v2.api.SyntheticsApi.SearchSuitesOptionalParameters).

Returns:

CompletableFuture<SyntheticsSuiteSearchResponse>

searchSuites

public SyntheticsSuiteSearchResponse searchSuites(SyntheticsApi.SearchSuitesOptionalParameters parameters)
                                           throws ApiException

Search Synthetics suites.

See searchSuitesWithHttpInfo(com.datadog.api.client.v2.api.SyntheticsApi.SearchSuitesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

SyntheticsSuiteSearchResponse

Throws:

ApiException - if fails to make API call

searchSuitesAsync

public CompletableFuture<SyntheticsSuiteSearchResponse> searchSuitesAsync(SyntheticsApi.SearchSuitesOptionalParameters parameters)

Search Synthetics suites.

See searchSuitesWithHttpInfoAsync(com.datadog.api.client.v2.api.SyntheticsApi.SearchSuitesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SyntheticsSuiteSearchResponse>

searchSuitesWithHttpInfo

public ApiResponse<SyntheticsSuiteSearchResponse> searchSuitesWithHttpInfo(SyntheticsApi.SearchSuitesOptionalParameters parameters)
                                                                    throws ApiException

Search for Synthetics suites.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<SyntheticsSuiteSearchResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	API error response.	-
429	Too many requests	-

searchSuitesWithHttpInfoAsync

public CompletableFuture<ApiResponse<SyntheticsSuiteSearchResponse>> searchSuitesWithHttpInfoAsync(SyntheticsApi.SearchSuitesOptionalParameters parameters)

Search Synthetics suites.

See searchSuitesWithHttpInfo(com.datadog.api.client.v2.api.SyntheticsApi.SearchSuitesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SyntheticsSuiteSearchResponse>>

setOnDemandConcurrencyCap

public OnDemandConcurrencyCapResponse setOnDemandConcurrencyCap(OnDemandConcurrencyCapAttributes body)
                                                         throws ApiException

Save new value for on-demand concurrency cap.

See setOnDemandConcurrencyCapWithHttpInfo(com.datadog.api.client.v2.model.OnDemandConcurrencyCapAttributes).

Parameters:

body - . (required)

Returns:

OnDemandConcurrencyCapResponse

Throws:

ApiException - if fails to make API call

setOnDemandConcurrencyCapAsync

public CompletableFuture<OnDemandConcurrencyCapResponse> setOnDemandConcurrencyCapAsync(OnDemandConcurrencyCapAttributes body)

Save new value for on-demand concurrency cap.

See setOnDemandConcurrencyCapWithHttpInfoAsync(com.datadog.api.client.v2.model.OnDemandConcurrencyCapAttributes).

Parameters:

body - . (required)

Returns:

CompletableFuture<OnDemandConcurrencyCapResponse>

setOnDemandConcurrencyCapWithHttpInfo

public ApiResponse<OnDemandConcurrencyCapResponse> setOnDemandConcurrencyCapWithHttpInfo(OnDemandConcurrencyCapAttributes body)
                                                                                  throws ApiException

Save new value for on-demand concurrency cap.

Parameters:

body - . (required)

Returns:

ApiResponse<OnDemandConcurrencyCapResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
429	Too many requests	-

setOnDemandConcurrencyCapWithHttpInfoAsync

public CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>> setOnDemandConcurrencyCapWithHttpInfoAsync(OnDemandConcurrencyCapAttributes body)

Save new value for on-demand concurrency cap.

See setOnDemandConcurrencyCapWithHttpInfo(com.datadog.api.client.v2.model.OnDemandConcurrencyCapAttributes).

Parameters:

body - . (required)

Returns:

CompletableFuture<ApiResponse<OnDemandConcurrencyCapResponse>>