Package com.datadog.api.client.v1.api
Class SyntheticsApi
java.lang.Object
com.datadog.api.client.v1.api.SyntheticsApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SyntheticsApi
extends Object
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to getAPITestLatestResults.static classManage optional parameters to getBrowserTestLatestResults.static classManage optional parameters to listTests.static classManage optional parameters to searchTests. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate a global variable.Create a global variable.Create a Synthetic global variable.Create a global variable.Create a private location.Create a private location.Create a new Synthetic private location.Create a private location.Create an API test.Create an API test.Create a Synthetic API test.Create an API test.Create a browser test.Create a browser test.Create a Synthetic browser test.Create a browser test.Create a mobile test.Create a mobile test.Create a Synthetic mobile test.Create a mobile test.voiddeleteGlobalVariable(String variableId) Delete a global variable.deleteGlobalVariableAsync(String variableId) Delete a global variable.deleteGlobalVariableWithHttpInfo(String variableId) Delete a Synthetic global variable.deleteGlobalVariableWithHttpInfoAsync(String variableId) Delete a global variable.voiddeletePrivateLocation(String locationId) Delete a private location.deletePrivateLocationAsync(String locationId) Delete a private location.deletePrivateLocationWithHttpInfo(String locationId) Delete a Synthetic private location.deletePrivateLocationWithHttpInfoAsync(String locationId) Delete a private location.Delete tests.Delete tests.Delete multiple Synthetic tests by ID.Delete tests.editGlobalVariable(String variableId, SyntheticsGlobalVariableRequest body) Edit a global variable.editGlobalVariableAsync(String variableId, SyntheticsGlobalVariableRequest body) Edit a global variable.editGlobalVariableWithHttpInfo(String variableId, SyntheticsGlobalVariableRequest body) Edit a Synthetic global variable.editGlobalVariableWithHttpInfoAsync(String variableId, SyntheticsGlobalVariableRequest body) Edit a global variable.Fetch uptime for multiple tests.Fetch uptime for multiple tests.Fetch uptime for multiple Synthetic tests by ID.Fetch uptime for multiple tests.Get the API client.getAPITest(String publicId) Get an API test.getAPITestAsync(String publicId) Get an API test.getAPITestLatestResults(String publicId) Get an API test's latest results summaries.getAPITestLatestResults(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.getAPITestLatestResultsAsync(String publicId) Get an API test's latest results summaries.getAPITestLatestResultsAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.getAPITestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get the last 150 test results summaries for a given Synthetic API test.getAPITestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.getAPITestResult(String publicId, String resultId) Get an API test result.getAPITestResultAsync(String publicId, String resultId) Get an API test result.getAPITestResultWithHttpInfo(String publicId, String resultId) Get a specific full result from a given Synthetic API test.getAPITestResultWithHttpInfoAsync(String publicId, String resultId) Get an API test result.getAPITestWithHttpInfo(String publicId) Get the detailed configuration associated with a Synthetic API test.getAPITestWithHttpInfoAsync(String publicId) Get an API test.getBrowserTest(String publicId) Get a browser test.getBrowserTestAsync(String publicId) Get a browser test.getBrowserTestLatestResults(String publicId) Get a browser test's latest results summaries.getBrowserTestLatestResults(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.getBrowserTestLatestResultsAsync(String publicId) Get a browser test's latest results summaries.getBrowserTestLatestResultsAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.getBrowserTestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get the last 150 test results summaries for a given Synthetic browser test.getBrowserTestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.getBrowserTestResult(String publicId, String resultId) Get a browser test result.getBrowserTestResultAsync(String publicId, String resultId) Get a browser test result.getBrowserTestResultWithHttpInfo(String publicId, String resultId) Get a specific full result from a given Synthetic browser test.getBrowserTestResultWithHttpInfoAsync(String publicId, String resultId) Get a browser test result.getBrowserTestWithHttpInfo(String publicId) Get the detailed configuration (including steps) associated with a Synthetic browser test.getBrowserTestWithHttpInfoAsync(String publicId) Get a browser test.getGlobalVariable(String variableId) Get a global variable.getGlobalVariableAsync(String variableId) Get a global variable.getGlobalVariableWithHttpInfo(String variableId) Get the detailed configuration of a global variable.getGlobalVariableWithHttpInfoAsync(String variableId) Get a global variable.getMobileTest(String publicId) Get a mobile test.getMobileTestAsync(String publicId) Get a mobile test.getMobileTestWithHttpInfo(String publicId) Get the detailed configuration associated with a Synthetic mobile test.getMobileTestWithHttpInfoAsync(String publicId) Get a mobile test.getPrivateLocation(String locationId) Get a private location.getPrivateLocationAsync(String locationId) Get a private location.getPrivateLocationWithHttpInfo(String locationId) Get a Synthetic private location.getPrivateLocationWithHttpInfoAsync(String locationId) Get a private location.getSyntheticsCIBatch(String batchId) Get details of batch.getSyntheticsCIBatchAsync(String batchId) Get details of batch.getSyntheticsCIBatchWithHttpInfo(String batchId) Get a batch's updated details.Get details of batch.Get the default locations.Get the default locations.Get the default locations settings.Get the default locations.Get a test configuration.getTestAsync(String publicId) Get a test configuration.getTestWithHttpInfo(String publicId) Get the detailed configuration associated with a Synthetic test.getTestWithHttpInfoAsync(String publicId) Get a test configuration.Get all global variables.Get all global variables.Get the list of all Synthetic global variables.Get all global variables.Get all locations (public and private).Get all locations (public and private).Get the list of public and private locations available for Synthetic tests.Get all locations (public and private).Get the list of all Synthetic tests.listTests(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.Get the list of all Synthetic tests.Get the list of all Synthetic tests.Get the list of all Synthetic tests.Get the list of all Synthetic tests.Get the list of all Synthetic tests.Get the list of all Synthetic tests.patchTest(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.patchTestAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.patchTestWithHttpInfo(String publicId, SyntheticsPatchTestBody body) Patch the configuration of a Synthetic test with partial data.patchTestWithHttpInfoAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.Search Synthetic tests.Search Synthetic tests.Search Synthetic tests.Search Synthetic tests.Search for Synthetic tests.Search Synthetic tests.voidsetApiClient(ApiClient apiClient) Set the API client.Trigger tests from CI/CD pipelines.Trigger tests from CI/CD pipelines.Trigger a set of Synthetic tests for continuous integration.Trigger tests from CI/CD pipelines.Trigger Synthetic tests.Trigger Synthetic tests.Trigger a set of Synthetic tests.Trigger Synthetic tests.updateAPITest(String publicId, SyntheticsAPITest body) Edit an API test.updateAPITestAsync(String publicId, SyntheticsAPITest body) Edit an API test.updateAPITestWithHttpInfo(String publicId, SyntheticsAPITest body) Edit the configuration of a Synthetic API test.updateAPITestWithHttpInfoAsync(String publicId, SyntheticsAPITest body) Edit an API test.updateBrowserTest(String publicId, SyntheticsBrowserTest body) Edit a browser test.updateBrowserTestAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.updateBrowserTestWithHttpInfo(String publicId, SyntheticsBrowserTest body) Edit the configuration of a Synthetic browser test.updateBrowserTestWithHttpInfoAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.updateMobileTest(String publicId, SyntheticsMobileTest body) Edit a mobile test.updateMobileTestAsync(String publicId, SyntheticsMobileTest body) Edit a mobile test.updateMobileTestWithHttpInfo(String publicId, SyntheticsMobileTest body) Edit the configuration of a Synthetic mobile test.updateMobileTestWithHttpInfoAsync(String publicId, SyntheticsMobileTest body) Edit a mobile test.updatePrivateLocation(String locationId, SyntheticsPrivateLocation body) Edit a private location.updatePrivateLocationAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.updatePrivateLocationWithHttpInfo(String locationId, SyntheticsPrivateLocation body) Edit a Synthetic private location.updatePrivateLocationWithHttpInfoAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.updateTestPauseStatus(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.updateTestPauseStatusAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.Pause or start a Synthetic test by changing the status.updateTestPauseStatusWithHttpInfoAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.
-
Constructor Details
-
SyntheticsApi
public SyntheticsApi() -
SyntheticsApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createGlobalVariable
public SyntheticsGlobalVariable createGlobalVariable(SyntheticsGlobalVariableRequest body) throws ApiException Create a global variable.See
createGlobalVariableWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsGlobalVariableRequest).- Parameters:
body- Details of the global variable to create. (required)- Returns:
- SyntheticsGlobalVariable
- Throws:
ApiException- if fails to make API call
-
createGlobalVariableAsync
public CompletableFuture<SyntheticsGlobalVariable> createGlobalVariableAsync(SyntheticsGlobalVariableRequest body) Create a global variable.- Parameters:
body- Details of the global variable to create. (required)- Returns:
- CompletableFuture<SyntheticsGlobalVariable>
-
createGlobalVariableWithHttpInfo
public ApiResponse<SyntheticsGlobalVariable> createGlobalVariableWithHttpInfo(SyntheticsGlobalVariableRequest body) throws ApiException Create a Synthetic global variable.- Parameters:
body- Details of the global variable to create. (required)- Returns:
- ApiResponse<SyntheticsGlobalVariable>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Invalid request - 403 Forbidden - 409 Conflict - 429 Too many requests -
-
createGlobalVariableWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> createGlobalVariableWithHttpInfoAsync(SyntheticsGlobalVariableRequest body) Create a global variable.See
createGlobalVariableWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsGlobalVariableRequest).- Parameters:
body- Details of the global variable to create. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>
-
createPrivateLocation
public SyntheticsPrivateLocationCreationResponse createPrivateLocation(SyntheticsPrivateLocation body) throws ApiException Create a private location.See
createPrivateLocationWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).- Parameters:
body- Details of the private location to create. (required)- Returns:
- SyntheticsPrivateLocationCreationResponse
- Throws:
ApiException- if fails to make API call
-
createPrivateLocationAsync
public CompletableFuture<SyntheticsPrivateLocationCreationResponse> createPrivateLocationAsync(SyntheticsPrivateLocation body) Create a private location.See
createPrivateLocationWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).- Parameters:
body- Details of the private location to create. (required)- Returns:
- CompletableFuture<SyntheticsPrivateLocationCreationResponse>
-
createPrivateLocationWithHttpInfo
public ApiResponse<SyntheticsPrivateLocationCreationResponse> createPrivateLocationWithHttpInfo(SyntheticsPrivateLocation body) throws ApiException Create a new Synthetic private location.- Parameters:
body- Details of the private location to create. (required)- Returns:
- ApiResponse<SyntheticsPrivateLocationCreationResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 402 Quota reached for private locations - 404 Private locations are not activated for the user - 429 Too many requests -
-
createPrivateLocationWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsPrivateLocationCreationResponse>> createPrivateLocationWithHttpInfoAsync(SyntheticsPrivateLocation body) Create a private location.See
createPrivateLocationWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsPrivateLocation).- Parameters:
body- Details of the private location to create. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsPrivateLocationCreationResponse>>
-
createSyntheticsAPITest
Create an API test.See
createSyntheticsAPITestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
body- Details of the test to create. (required)- Returns:
- SyntheticsAPITest
- Throws:
ApiException- if fails to make API call
-
createSyntheticsAPITestAsync
Create an API test.See
createSyntheticsAPITestWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<SyntheticsAPITest>
-
createSyntheticsAPITestWithHttpInfo
public ApiResponse<SyntheticsAPITest> createSyntheticsAPITestWithHttpInfo(SyntheticsAPITest body) throws ApiException Create a Synthetic API test.- Parameters:
body- Details of the test to create. (required)- Returns:
- ApiResponse<SyntheticsAPITest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - 429 Too many requests -
-
createSyntheticsAPITestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsAPITest>> createSyntheticsAPITestWithHttpInfoAsync(SyntheticsAPITest body) Create an API test.See
createSyntheticsAPITestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsAPITest>>
-
createSyntheticsBrowserTest
public SyntheticsBrowserTest createSyntheticsBrowserTest(SyntheticsBrowserTest body) throws ApiException Create a browser test.See
createSyntheticsBrowserTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsBrowserTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- SyntheticsBrowserTest
- Throws:
ApiException- if fails to make API call
-
createSyntheticsBrowserTestAsync
public CompletableFuture<SyntheticsBrowserTest> createSyntheticsBrowserTestAsync(SyntheticsBrowserTest body) Create a browser test.See
createSyntheticsBrowserTestWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsBrowserTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<SyntheticsBrowserTest>
-
createSyntheticsBrowserTestWithHttpInfo
public ApiResponse<SyntheticsBrowserTest> createSyntheticsBrowserTestWithHttpInfo(SyntheticsBrowserTest body) throws ApiException Create a Synthetic browser test.- Parameters:
body- Details of the test to create. (required)- Returns:
- ApiResponse<SyntheticsBrowserTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - 429 Too many requests -
-
createSyntheticsBrowserTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> createSyntheticsBrowserTestWithHttpInfoAsync(SyntheticsBrowserTest body) Create a browser test.See
createSyntheticsBrowserTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsBrowserTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsBrowserTest>>
-
createSyntheticsMobileTest
public SyntheticsMobileTest createSyntheticsMobileTest(SyntheticsMobileTest body) throws ApiException Create a mobile test.See
createSyntheticsMobileTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsMobileTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- SyntheticsMobileTest
- Throws:
ApiException- if fails to make API call
-
createSyntheticsMobileTestAsync
public CompletableFuture<SyntheticsMobileTest> createSyntheticsMobileTestAsync(SyntheticsMobileTest body) Create a mobile test.See
createSyntheticsMobileTestWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsMobileTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<SyntheticsMobileTest>
-
createSyntheticsMobileTestWithHttpInfo
public ApiResponse<SyntheticsMobileTest> createSyntheticsMobileTestWithHttpInfo(SyntheticsMobileTest body) throws ApiException Create a Synthetic mobile test.- Parameters:
body- Details of the test to create. (required)- Returns:
- ApiResponse<SyntheticsMobileTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns the created test details. - 400 - JSON format is wrong - Creation failed - 402 Test quota is reached - 403 Forbidden - 429 Too many requests -
-
createSyntheticsMobileTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsMobileTest>> createSyntheticsMobileTestWithHttpInfoAsync(SyntheticsMobileTest body) Create a mobile test.See
createSyntheticsMobileTestWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsMobileTest).- Parameters:
body- Details of the test to create. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsMobileTest>>
-
deleteGlobalVariable
Delete a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Throws:
ApiException- if fails to make API call
-
deleteGlobalVariableAsync
Delete a global variable.See
deleteGlobalVariableWithHttpInfoAsync(java.lang.String).- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- CompletableFuture
-
deleteGlobalVariableWithHttpInfo
Delete a Synthetic global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 JSON format is wrong - 403 Forbidden - 404 Not found - 429 Too many requests -
-
deleteGlobalVariableWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deleteGlobalVariableWithHttpInfoAsync(String variableId) Delete a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deletePrivateLocation
Delete a private location.- Parameters:
locationId- The ID of the private location. (required)- Throws:
ApiException- if fails to make API call
-
deletePrivateLocationAsync
Delete a private location.See
deletePrivateLocationWithHttpInfoAsync(java.lang.String).- Parameters:
locationId- The ID of the private location. (required)- Returns:
- CompletableFuture
-
deletePrivateLocationWithHttpInfo
Delete a Synthetic private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 204 OK - 404 - Private locations are not activated for the user - Private location does not exist - 429 Too many requests -
-
deletePrivateLocationWithHttpInfoAsync
public CompletableFuture<ApiResponse<Void>> deletePrivateLocationWithHttpInfoAsync(String locationId) Delete a private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteTests
public SyntheticsDeleteTestsResponse deleteTests(SyntheticsDeleteTestsPayload body) throws ApiException Delete tests.See
deleteTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).- Parameters:
body- Public ID list of the Synthetic tests to be deleted. (required)- Returns:
- SyntheticsDeleteTestsResponse
- Throws:
ApiException- if fails to make API call
-
deleteTestsAsync
public CompletableFuture<SyntheticsDeleteTestsResponse> deleteTestsAsync(SyntheticsDeleteTestsPayload body) Delete tests.See
deleteTestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).- Parameters:
body- Public ID list of the Synthetic tests to be deleted. (required)- Returns:
- CompletableFuture<SyntheticsDeleteTestsResponse>
-
deleteTestsWithHttpInfo
public ApiResponse<SyntheticsDeleteTestsResponse> deleteTestsWithHttpInfo(SyntheticsDeleteTestsPayload body) throws ApiException Delete multiple Synthetic tests by ID.- Parameters:
body- Public ID list of the Synthetic tests to be deleted. (required)- Returns:
- ApiResponse<SyntheticsDeleteTestsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK. - 400 - JSON format is wrong - Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget) - Some IDs are not owned by the user - 403 Forbidden - 404 - Tests to be deleted can't be found - Synthetic is not activated for the user - 429 Too many requests -
-
deleteTestsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsDeleteTestsResponse>> deleteTestsWithHttpInfoAsync(SyntheticsDeleteTestsPayload body) Delete tests.See
deleteTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsDeleteTestsPayload).- Parameters:
body- Public ID list of the Synthetic tests to be deleted. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsDeleteTestsResponse>>
-
editGlobalVariable
public SyntheticsGlobalVariable editGlobalVariable(String variableId, SyntheticsGlobalVariableRequest body) throws ApiException Edit a global variable.- Parameters:
variableId- The ID of the global variable. (required)body- Details of the global variable to update. (required)- Returns:
- SyntheticsGlobalVariable
- Throws:
ApiException- if fails to make API call
-
editGlobalVariableAsync
public CompletableFuture<SyntheticsGlobalVariable> editGlobalVariableAsync(String variableId, SyntheticsGlobalVariableRequest body) Edit a global variable.- Parameters:
variableId- The ID of the global variable. (required)body- Details of the global variable to update. (required)- Returns:
- CompletableFuture<SyntheticsGlobalVariable>
-
editGlobalVariableWithHttpInfo
public ApiResponse<SyntheticsGlobalVariable> editGlobalVariableWithHttpInfo(String variableId, SyntheticsGlobalVariableRequest body) throws ApiException Edit a Synthetic global variable.- Parameters:
variableId- The ID of the global variable. (required)body- Details of the global variable to update. (required)- Returns:
- ApiResponse<SyntheticsGlobalVariable>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Invalid request - 403 Forbidden - 429 Too many requests -
-
editGlobalVariableWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> editGlobalVariableWithHttpInfoAsync(String variableId, SyntheticsGlobalVariableRequest body) Edit a global variable.- Parameters:
variableId- The ID of the global variable. (required)body- Details of the global variable to update. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>
-
fetchUptimes
public List<SyntheticsTestUptime> fetchUptimes(SyntheticsFetchUptimesPayload body) throws ApiException Fetch uptime for multiple tests.See
fetchUptimesWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsFetchUptimesPayload).- Parameters:
body- Public ID list of the Synthetic tests and timeframe. (required)- Returns:
- List<SyntheticsTestUptime>
- Throws:
ApiException- if fails to make API call
-
fetchUptimesAsync
public CompletableFuture<List<SyntheticsTestUptime>> fetchUptimesAsync(SyntheticsFetchUptimesPayload body) Fetch uptime for multiple tests.See
fetchUptimesWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsFetchUptimesPayload).- Parameters:
body- Public ID list of the Synthetic tests and timeframe. (required)- Returns:
- CompletableFuture<List<SyntheticsTestUptime>>
-
fetchUptimesWithHttpInfo
public ApiResponse<List<SyntheticsTestUptime>> fetchUptimesWithHttpInfo(SyntheticsFetchUptimesPayload body) throws ApiException Fetch uptime for multiple Synthetic tests by ID.- Parameters:
body- Public ID list of the Synthetic tests and timeframe. (required)- Returns:
- ApiResponse<List<SyntheticsTestUptime>>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK. - 400 - JSON format is wrong - 403 Forbidden - 429 Too many requests -
-
fetchUptimesWithHttpInfoAsync
public CompletableFuture<ApiResponse<List<SyntheticsTestUptime>>> fetchUptimesWithHttpInfoAsync(SyntheticsFetchUptimesPayload body) Fetch uptime for multiple tests.See
fetchUptimesWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsFetchUptimesPayload).- Parameters:
body- Public ID list of the Synthetic tests and timeframe. (required)- Returns:
- CompletableFuture<ApiResponse<List<SyntheticsTestUptime>>>
-
getAPITest
Get an API test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- SyntheticsAPITest
- Throws:
ApiException- if fails to make API call
-
getAPITestAsync
Get an API test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<SyntheticsAPITest>
-
getAPITestWithHttpInfo
Get the detailed configuration associated with a Synthetic API test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- ApiResponse<SyntheticsAPITest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getAPITestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsAPITest>> getAPITestWithHttpInfoAsync(String publicId) Get an API test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsAPITest>>
-
getAPITestLatestResults
public SyntheticsGetAPITestLatestResultsResponse getAPITestLatestResults(String publicId) throws ApiException Get an API test's latest results summaries.- Parameters:
publicId- The public ID of the test for which to search results for. (required)- Returns:
- SyntheticsGetAPITestLatestResultsResponse
- Throws:
ApiException- if fails to make API call
-
getAPITestLatestResultsAsync
public CompletableFuture<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsAsync(String publicId) Get an API test's latest results summaries.- Parameters:
publicId- The public ID of the test for which to search results for. (required)- Returns:
- CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>
-
getAPITestLatestResults
public SyntheticsGetAPITestLatestResultsResponse getAPITestLatestResults(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) throws ApiException Get an API test's latest results summaries.- Parameters:
publicId- The public ID of the test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- SyntheticsGetAPITestLatestResultsResponse
- Throws:
ApiException- if fails to make API call
-
getAPITestLatestResultsAsync
public CompletableFuture<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.- Parameters:
publicId- The public ID of the test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SyntheticsGetAPITestLatestResultsResponse>
-
getAPITestLatestResultsWithHttpInfo
public ApiResponse<SyntheticsGetAPITestLatestResultsResponse> getAPITestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) throws ApiException Get the last 150 test results summaries for a given Synthetic API test.- Parameters:
publicId- The public ID of the test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SyntheticsGetAPITestLatestResultsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getAPITestLatestResultsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsGetAPITestLatestResultsResponse>> getAPITestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetAPITestLatestResultsOptionalParameters parameters) Get an API test's latest results summaries.- Parameters:
publicId- The public ID of the test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SyntheticsGetAPITestLatestResultsResponse>>
-
getAPITestResult
public SyntheticsAPITestResultFull getAPITestResult(String publicId, String resultId) throws ApiException Get an API test result.See
getAPITestResultWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the API test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- SyntheticsAPITestResultFull
- Throws:
ApiException- if fails to make API call
-
getAPITestResultAsync
public CompletableFuture<SyntheticsAPITestResultFull> getAPITestResultAsync(String publicId, String resultId) Get an API test result.See
getAPITestResultWithHttpInfoAsync(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the API test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- CompletableFuture<SyntheticsAPITestResultFull>
-
getAPITestResultWithHttpInfo
public ApiResponse<SyntheticsAPITestResultFull> getAPITestResultWithHttpInfo(String publicId, String resultId) throws ApiException Get a specific full result from a given Synthetic API test.- Parameters:
publicId- The public ID of the API test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- ApiResponse<SyntheticsAPITestResultFull>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test or result is not owned by the user - 429 Too many requests -
-
getAPITestResultWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsAPITestResultFull>> getAPITestResultWithHttpInfoAsync(String publicId, String resultId) Get an API test result.See
getAPITestResultWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the API test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsAPITestResultFull>>
-
getBrowserTest
Get a browser test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- SyntheticsBrowserTest
- Throws:
ApiException- if fails to make API call
-
getBrowserTestAsync
Get a browser test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<SyntheticsBrowserTest>
-
getBrowserTestWithHttpInfo
public ApiResponse<SyntheticsBrowserTest> getBrowserTestWithHttpInfo(String publicId) throws ApiException Get the detailed configuration (including steps) associated with a Synthetic browser test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- ApiResponse<SyntheticsBrowserTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getBrowserTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> getBrowserTestWithHttpInfoAsync(String publicId) Get a browser test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsBrowserTest>>
-
getBrowserTestLatestResults
public SyntheticsGetBrowserTestLatestResultsResponse getBrowserTestLatestResults(String publicId) throws ApiException Get a browser test's latest results summaries.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)- Returns:
- SyntheticsGetBrowserTestLatestResultsResponse
- Throws:
ApiException- if fails to make API call
-
getBrowserTestLatestResultsAsync
public CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsAsync(String publicId) Get a browser test's latest results summaries.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)- Returns:
- CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>
-
getBrowserTestLatestResults
public SyntheticsGetBrowserTestLatestResultsResponse getBrowserTestLatestResults(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) throws ApiException Get a browser test's latest results summaries.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- SyntheticsGetBrowserTestLatestResultsResponse
- Throws:
ApiException- if fails to make API call
-
getBrowserTestLatestResultsAsync
public CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SyntheticsGetBrowserTestLatestResultsResponse>
-
getBrowserTestLatestResultsWithHttpInfo
public ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse> getBrowserTestLatestResultsWithHttpInfo(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) throws ApiException Get the last 150 test results summaries for a given Synthetic browser test.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getBrowserTestLatestResultsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>> getBrowserTestLatestResultsWithHttpInfoAsync(String publicId, SyntheticsApi.GetBrowserTestLatestResultsOptionalParameters parameters) Get a browser test's latest results summaries.- Parameters:
publicId- The public ID of the browser test for which to search results for. (required)parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SyntheticsGetBrowserTestLatestResultsResponse>>
-
getBrowserTestResult
public SyntheticsBrowserTestResultFull getBrowserTestResult(String publicId, String resultId) throws ApiException Get a browser test result.See
getBrowserTestResultWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the browser test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- SyntheticsBrowserTestResultFull
- Throws:
ApiException- if fails to make API call
-
getBrowserTestResultAsync
public CompletableFuture<SyntheticsBrowserTestResultFull> getBrowserTestResultAsync(String publicId, String resultId) Get a browser test result.See
getBrowserTestResultWithHttpInfoAsync(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the browser test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- CompletableFuture<SyntheticsBrowserTestResultFull>
-
getBrowserTestResultWithHttpInfo
public ApiResponse<SyntheticsBrowserTestResultFull> getBrowserTestResultWithHttpInfo(String publicId, String resultId) throws ApiException Get a specific full result from a given Synthetic browser test.- Parameters:
publicId- The public ID of the browser test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- ApiResponse<SyntheticsBrowserTestResultFull>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test or result is not owned by the user - 429 Too many requests -
-
getBrowserTestResultWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsBrowserTestResultFull>> getBrowserTestResultWithHttpInfoAsync(String publicId, String resultId) Get a browser test result.See
getBrowserTestResultWithHttpInfo(java.lang.String, java.lang.String).- Parameters:
publicId- The public ID of the browser test to which the target result belongs. (required)resultId- The ID of the result to get. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsBrowserTestResultFull>>
-
getGlobalVariable
Get a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- SyntheticsGlobalVariable
- Throws:
ApiException- if fails to make API call
-
getGlobalVariableAsync
Get a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- CompletableFuture<SyntheticsGlobalVariable>
-
getGlobalVariableWithHttpInfo
public ApiResponse<SyntheticsGlobalVariable> getGlobalVariableWithHttpInfo(String variableId) throws ApiException Get the detailed configuration of a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- ApiResponse<SyntheticsGlobalVariable>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 Not found - 429 Too many requests -
-
getGlobalVariableWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsGlobalVariable>> getGlobalVariableWithHttpInfoAsync(String variableId) Get a global variable.- Parameters:
variableId- The ID of the global variable. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsGlobalVariable>>
-
getMobileTest
Get a mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- SyntheticsMobileTest
- Throws:
ApiException- if fails to make API call
-
getMobileTestAsync
Get a mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<SyntheticsMobileTest>
-
getMobileTestWithHttpInfo
public ApiResponse<SyntheticsMobileTest> getMobileTestWithHttpInfo(String publicId) throws ApiException Get the detailed configuration associated with a Synthetic mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- ApiResponse<SyntheticsMobileTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getMobileTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsMobileTest>> getMobileTestWithHttpInfoAsync(String publicId) Get a mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsMobileTest>>
-
getPrivateLocation
Get a private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- SyntheticsPrivateLocation
- Throws:
ApiException- if fails to make API call
-
getPrivateLocationAsync
Get a private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- CompletableFuture<SyntheticsPrivateLocation>
-
getPrivateLocationWithHttpInfo
public ApiResponse<SyntheticsPrivateLocation> getPrivateLocationWithHttpInfo(String locationId) throws ApiException Get a Synthetic private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- ApiResponse<SyntheticsPrivateLocation>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 404 - Synthetic private locations are not activated for the user - Private location does not exist - 429 Too many requests -
-
getPrivateLocationWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsPrivateLocation>> getPrivateLocationWithHttpInfoAsync(String locationId) Get a private location.- Parameters:
locationId- The ID of the private location. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>
-
getSyntheticsCIBatch
Get details of batch.- Parameters:
batchId- The ID of the batch. (required)- Returns:
- SyntheticsBatchDetails
- Throws:
ApiException- if fails to make API call
-
getSyntheticsCIBatchAsync
Get details of batch.See
getSyntheticsCIBatchWithHttpInfoAsync(java.lang.String).- Parameters:
batchId- The ID of the batch. (required)- Returns:
- CompletableFuture<SyntheticsBatchDetails>
-
getSyntheticsCIBatchWithHttpInfo
public ApiResponse<SyntheticsBatchDetails> getSyntheticsCIBatchWithHttpInfo(String batchId) throws ApiException Get a batch's updated details.- Parameters:
batchId- The ID of the batch. (required)- Returns:
- ApiResponse<SyntheticsBatchDetails>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 404 Batch does not exist. - 429 Too many requests -
-
getSyntheticsCIBatchWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsBatchDetails>> getSyntheticsCIBatchWithHttpInfoAsync(String batchId) Get details of batch.- Parameters:
batchId- The ID of the batch. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsBatchDetails>>
-
getSyntheticsDefaultLocations
Get the default locations.- Returns:
- List<String>
- Throws:
ApiException- if fails to make API call
-
getSyntheticsDefaultLocationsAsync
Get the default locations.- Returns:
- CompletableFuture<List<String>>
-
getSyntheticsDefaultLocationsWithHttpInfo
Get the default locations settings.- Returns:
- ApiResponse<List<String>>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 429 Too many requests -
-
getSyntheticsDefaultLocationsWithHttpInfoAsync
public CompletableFuture<ApiResponse<List<String>>> getSyntheticsDefaultLocationsWithHttpInfoAsync()Get the default locations.- Returns:
- CompletableFuture<ApiResponse<List<String>>>
-
getTest
Get a test configuration.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- SyntheticsTestDetailsWithoutSteps
- Throws:
ApiException- if fails to make API call
-
getTestAsync
Get a test configuration.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<SyntheticsTestDetailsWithoutSteps>
-
getTestWithHttpInfo
public ApiResponse<SyntheticsTestDetailsWithoutSteps> getTestWithHttpInfo(String publicId) throws ApiException Get the detailed configuration associated with a Synthetic test.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- ApiResponse<SyntheticsTestDetailsWithoutSteps>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 404 - Synthetic is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
getTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsTestDetailsWithoutSteps>> getTestWithHttpInfoAsync(String publicId) Get a test configuration.- Parameters:
publicId- The public ID of the test to get details from. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsTestDetailsWithoutSteps>>
-
listGlobalVariables
Get all global variables.- Returns:
- SyntheticsListGlobalVariablesResponse
- Throws:
ApiException- if fails to make API call
-
listGlobalVariablesAsync
Get all global variables.- Returns:
- CompletableFuture<SyntheticsListGlobalVariablesResponse>
-
listGlobalVariablesWithHttpInfo
public ApiResponse<SyntheticsListGlobalVariablesResponse> listGlobalVariablesWithHttpInfo() throws ApiExceptionGet the list of all Synthetic global variables.- Returns:
- ApiResponse<SyntheticsListGlobalVariablesResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 403 Forbidden - 429 Too many requests -
-
listGlobalVariablesWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsListGlobalVariablesResponse>> listGlobalVariablesWithHttpInfoAsync()Get all global variables.- Returns:
- CompletableFuture<ApiResponse<SyntheticsListGlobalVariablesResponse>>
-
listLocations
Get all locations (public and private).- Returns:
- SyntheticsLocations
- Throws:
ApiException- if fails to make API call
-
listLocationsAsync
Get all locations (public and private).- Returns:
- CompletableFuture<SyntheticsLocations>
-
listLocationsWithHttpInfo
Get the list of public and private locations available for Synthetic tests. No arguments required.- Returns:
- ApiResponse<SyntheticsLocations>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 429 Too many requests -
-
listLocationsWithHttpInfoAsync
Get all locations (public and private).- Returns:
- CompletableFuture<ApiResponse<SyntheticsLocations>>
-
listTests
Get the list of all Synthetic tests.See
listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Returns:
- SyntheticsListTestsResponse
- Throws:
ApiException- if fails to make API call
-
listTestsAsync
Get the list of all Synthetic tests.See
listTestsWithHttpInfoAsync(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Returns:
- CompletableFuture<SyntheticsListTestsResponse>
-
listTests
public SyntheticsListTestsResponse listTests(SyntheticsApi.ListTestsOptionalParameters parameters) throws ApiException Get the list of all Synthetic tests.See
listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- SyntheticsListTestsResponse
- Throws:
ApiException- if fails to make API call
-
listTestsAsync
public CompletableFuture<SyntheticsListTestsResponse> listTestsAsync(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.See
listTestsWithHttpInfoAsync(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SyntheticsListTestsResponse>
-
listTestsWithPagination
Get the list of all Synthetic tests.See
listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Returns:
- PaginationIterable<SyntheticsTestDetailsWithoutSteps>
-
listTestsWithPagination
public PaginationIterable<SyntheticsTestDetailsWithoutSteps> listTestsWithPagination(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.See
listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Returns:
- SyntheticsListTestsResponse
-
listTestsWithHttpInfo
public ApiResponse<SyntheticsListTestsResponse> listTestsWithHttpInfo(SyntheticsApi.ListTestsOptionalParameters parameters) throws ApiException Get the list of all Synthetic tests.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<SyntheticsListTestsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns the list of all Synthetic tests. - 403 Forbidden - 404 Synthetic Monitoring is not activated for the user. - 429 Too many requests -
-
listTestsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsListTestsResponse>> listTestsWithHttpInfoAsync(SyntheticsApi.ListTestsOptionalParameters parameters) Get the list of all Synthetic tests.See
listTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.ListTestsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SyntheticsListTestsResponse>>
-
patchTest
public SyntheticsTestDetails patchTest(String publicId, SyntheticsPatchTestBody body) throws ApiException Patch a Synthetic test.See
patchTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPatchTestBody).- Parameters:
publicId- The public ID of the test to patch. (required)body- JSON Patch compliant list of operations (required)- Returns:
- SyntheticsTestDetails
- Throws:
ApiException- if fails to make API call
-
patchTestAsync
public CompletableFuture<SyntheticsTestDetails> patchTestAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.- Parameters:
publicId- The public ID of the test to patch. (required)body- JSON Patch compliant list of operations (required)- Returns:
- CompletableFuture<SyntheticsTestDetails>
-
patchTestWithHttpInfo
public ApiResponse<SyntheticsTestDetails> patchTestWithHttpInfo(String publicId, SyntheticsPatchTestBody body) throws ApiException Patch the configuration of a Synthetic test with partial data.- Parameters:
publicId- The public ID of the test to patch. (required)body- JSON Patch compliant list of operations (required)- Returns:
- ApiResponse<SyntheticsTestDetails>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - 429 Too many requests -
-
patchTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsTestDetails>> patchTestWithHttpInfoAsync(String publicId, SyntheticsPatchTestBody body) Patch a Synthetic test.See
patchTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsPatchTestBody).- Parameters:
publicId- The public ID of the test to patch. (required)body- JSON Patch compliant list of operations (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsTestDetails>>
-
searchTests
Search Synthetic tests.See
searchTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.SearchTestsOptionalParameters).- Returns:
- SyntheticsListTestsResponse
- Throws:
ApiException- if fails to make API call
-
searchTestsAsync
Search Synthetic tests.- Returns:
- CompletableFuture<SyntheticsListTestsResponse>
-
searchTests
public SyntheticsListTestsResponse searchTests(SyntheticsApi.SearchTestsOptionalParameters parameters) throws ApiException Search Synthetic tests.See
searchTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.SearchTestsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- SyntheticsListTestsResponse
- Throws:
ApiException- if fails to make API call
-
searchTestsAsync
public CompletableFuture<SyntheticsListTestsResponse> searchTestsAsync(SyntheticsApi.SearchTestsOptionalParameters parameters) Search Synthetic tests.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<SyntheticsListTestsResponse>
-
searchTestsWithHttpInfo
public ApiResponse<SyntheticsListTestsResponse> searchTestsWithHttpInfo(SyntheticsApi.SearchTestsOptionalParameters parameters) throws ApiException Search for Synthetic tests.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<SyntheticsListTestsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns the list of Synthetic tests matching the search. - 403 Forbidden - 404 Not found - 429 Too many requests -
-
searchTestsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsListTestsResponse>> searchTestsWithHttpInfoAsync(SyntheticsApi.SearchTestsOptionalParameters parameters) Search Synthetic tests.See
searchTestsWithHttpInfo(com.datadog.api.client.v1.api.SyntheticsApi.SearchTestsOptionalParameters).- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<SyntheticsListTestsResponse>>
-
triggerCITests
public SyntheticsTriggerCITestsResponse triggerCITests(SyntheticsCITestBody body) throws ApiException Trigger tests from CI/CD pipelines.See
triggerCITestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsCITestBody).- Parameters:
body- Details of the test to trigger. (required)- Returns:
- SyntheticsTriggerCITestsResponse
- Throws:
ApiException- if fails to make API call
-
triggerCITestsAsync
public CompletableFuture<SyntheticsTriggerCITestsResponse> triggerCITestsAsync(SyntheticsCITestBody body) Trigger tests from CI/CD pipelines.See
triggerCITestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsCITestBody).- Parameters:
body- Details of the test to trigger. (required)- Returns:
- CompletableFuture<SyntheticsTriggerCITestsResponse>
-
triggerCITestsWithHttpInfo
public ApiResponse<SyntheticsTriggerCITestsResponse> triggerCITestsWithHttpInfo(SyntheticsCITestBody body) throws ApiException Trigger a set of Synthetic tests for continuous integration.- Parameters:
body- Details of the test to trigger. (required)- Returns:
- ApiResponse<SyntheticsTriggerCITestsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 JSON format is wrong - 429 Too many requests -
-
triggerCITestsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>> triggerCITestsWithHttpInfoAsync(SyntheticsCITestBody body) Trigger tests from CI/CD pipelines.See
triggerCITestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsCITestBody).- Parameters:
body- Details of the test to trigger. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>
-
triggerTests
public SyntheticsTriggerCITestsResponse triggerTests(SyntheticsTriggerBody body) throws ApiException Trigger Synthetic tests.See
triggerTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsTriggerBody).- Parameters:
body- The identifiers of the tests to trigger. (required)- Returns:
- SyntheticsTriggerCITestsResponse
- Throws:
ApiException- if fails to make API call
-
triggerTestsAsync
public CompletableFuture<SyntheticsTriggerCITestsResponse> triggerTestsAsync(SyntheticsTriggerBody body) Trigger Synthetic tests.See
triggerTestsWithHttpInfoAsync(com.datadog.api.client.v1.model.SyntheticsTriggerBody).- Parameters:
body- The identifiers of the tests to trigger. (required)- Returns:
- CompletableFuture<SyntheticsTriggerCITestsResponse>
-
triggerTestsWithHttpInfo
public ApiResponse<SyntheticsTriggerCITestsResponse> triggerTestsWithHttpInfo(SyntheticsTriggerBody body) throws ApiException Trigger a set of Synthetic tests.- Parameters:
body- The identifiers of the tests to trigger. (required)- Returns:
- ApiResponse<SyntheticsTriggerCITestsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 429 Too many requests -
-
triggerTestsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>> triggerTestsWithHttpInfoAsync(SyntheticsTriggerBody body) Trigger Synthetic tests.See
triggerTestsWithHttpInfo(com.datadog.api.client.v1.model.SyntheticsTriggerBody).- Parameters:
body- The identifiers of the tests to trigger. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsTriggerCITestsResponse>>
-
updateAPITest
Edit an API test.See
updateAPITestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- SyntheticsAPITest
- Throws:
ApiException- if fails to make API call
-
updateAPITestAsync
public CompletableFuture<SyntheticsAPITest> updateAPITestAsync(String publicId, SyntheticsAPITest body) Edit an API test.See
updateAPITestWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<SyntheticsAPITest>
-
updateAPITestWithHttpInfo
public ApiResponse<SyntheticsAPITest> updateAPITestWithHttpInfo(String publicId, SyntheticsAPITest body) throws ApiException Edit the configuration of a Synthetic API test.- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- ApiResponse<SyntheticsAPITest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - 429 Too many requests -
-
updateAPITestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsAPITest>> updateAPITestWithHttpInfoAsync(String publicId, SyntheticsAPITest body) Edit an API test.See
updateAPITestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsAPITest).- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsAPITest>>
-
updateBrowserTest
public SyntheticsBrowserTest updateBrowserTest(String publicId, SyntheticsBrowserTest body) throws ApiException Edit a browser test.- Parameters:
publicId- The public ID of the test to edit. (required)body- New test details to be saved. (required)- Returns:
- SyntheticsBrowserTest
- Throws:
ApiException- if fails to make API call
-
updateBrowserTestAsync
public CompletableFuture<SyntheticsBrowserTest> updateBrowserTestAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.- Parameters:
publicId- The public ID of the test to edit. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<SyntheticsBrowserTest>
-
updateBrowserTestWithHttpInfo
public ApiResponse<SyntheticsBrowserTest> updateBrowserTestWithHttpInfo(String publicId, SyntheticsBrowserTest body) throws ApiException Edit the configuration of a Synthetic browser test.- Parameters:
publicId- The public ID of the test to edit. (required)body- New test details to be saved. (required)- Returns:
- ApiResponse<SyntheticsBrowserTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - 429 Too many requests -
-
updateBrowserTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsBrowserTest>> updateBrowserTestWithHttpInfoAsync(String publicId, SyntheticsBrowserTest body) Edit a browser test.- Parameters:
publicId- The public ID of the test to edit. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsBrowserTest>>
-
updateMobileTest
public SyntheticsMobileTest updateMobileTest(String publicId, SyntheticsMobileTest body) throws ApiException Edit a mobile test.See
updateMobileTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsMobileTest).- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- SyntheticsMobileTest
- Throws:
ApiException- if fails to make API call
-
updateMobileTestAsync
public CompletableFuture<SyntheticsMobileTest> updateMobileTestAsync(String publicId, SyntheticsMobileTest body) Edit a mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<SyntheticsMobileTest>
-
updateMobileTestWithHttpInfo
public ApiResponse<SyntheticsMobileTest> updateMobileTestWithHttpInfo(String publicId, SyntheticsMobileTest body) throws ApiException Edit the configuration of a Synthetic mobile test.- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- ApiResponse<SyntheticsMobileTest>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 - JSON format is wrong - Updating sub-type is forbidden - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - Test can't be found - 429 Too many requests -
-
updateMobileTestWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsMobileTest>> updateMobileTestWithHttpInfoAsync(String publicId, SyntheticsMobileTest body) Edit a mobile test.See
updateMobileTestWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SyntheticsMobileTest).- Parameters:
publicId- The public ID of the test to get details from. (required)body- New test details to be saved. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsMobileTest>>
-
updatePrivateLocation
public SyntheticsPrivateLocation updatePrivateLocation(String locationId, SyntheticsPrivateLocation body) throws ApiException Edit a private location.- Parameters:
locationId- The ID of the private location. (required)body- Details of the private location to be updated. (required)- Returns:
- SyntheticsPrivateLocation
- Throws:
ApiException- if fails to make API call
-
updatePrivateLocationAsync
public CompletableFuture<SyntheticsPrivateLocation> updatePrivateLocationAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.- Parameters:
locationId- The ID of the private location. (required)body- Details of the private location to be updated. (required)- Returns:
- CompletableFuture<SyntheticsPrivateLocation>
-
updatePrivateLocationWithHttpInfo
public ApiResponse<SyntheticsPrivateLocation> updatePrivateLocationWithHttpInfo(String locationId, SyntheticsPrivateLocation body) throws ApiException Edit a Synthetic private location.- Parameters:
locationId- The ID of the private location. (required)body- Details of the private location to be updated. (required)- Returns:
- ApiResponse<SyntheticsPrivateLocation>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 404 - Private locations are not activated for the user - Private location does not exist - 429 Too many requests -
-
updatePrivateLocationWithHttpInfoAsync
public CompletableFuture<ApiResponse<SyntheticsPrivateLocation>> updatePrivateLocationWithHttpInfoAsync(String locationId, SyntheticsPrivateLocation body) Edit a private location.- Parameters:
locationId- The ID of the private location. (required)body- Details of the private location to be updated. (required)- Returns:
- CompletableFuture<ApiResponse<SyntheticsPrivateLocation>>
-
updateTestPauseStatus
public Boolean updateTestPauseStatus(String publicId, SyntheticsUpdateTestPauseStatusPayload body) throws ApiException Pause or start a test.- Parameters:
publicId- The public ID of the Synthetic test to update. (required)body- Status to set the given Synthetic test to. (required)- Returns:
- Boolean
- Throws:
ApiException- if fails to make API call
-
updateTestPauseStatusAsync
public CompletableFuture<Boolean> updateTestPauseStatusAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.- Parameters:
publicId- The public ID of the Synthetic test to update. (required)body- Status to set the given Synthetic test to. (required)- Returns:
- CompletableFuture<Boolean>
-
updateTestPauseStatusWithHttpInfo
public ApiResponse<Boolean> updateTestPauseStatusWithHttpInfo(String publicId, SyntheticsUpdateTestPauseStatusPayload body) throws ApiException Pause or start a Synthetic test by changing the status.- Parameters:
publicId- The public ID of the Synthetic test to update. (required)body- Status to set the given Synthetic test to. (required)- Returns:
- ApiResponse<Boolean>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - Returns a boolean indicating if the update was successful. - 400 JSON format is wrong. - 403 Forbidden - 404 - Synthetic Monitoring is not activated for the user - Test is not owned by the user - 429 Too many requests -
-
updateTestPauseStatusWithHttpInfoAsync
public CompletableFuture<ApiResponse<Boolean>> updateTestPauseStatusWithHttpInfoAsync(String publicId, SyntheticsUpdateTestPauseStatusPayload body) Pause or start a test.- Parameters:
publicId- The public ID of the Synthetic test to update. (required)body- Status to set the given Synthetic test to. (required)- Returns:
- CompletableFuture<ApiResponse<Boolean>>
-