com.datadog.api.client.v2.api

Class DeploymentGatesApi

java.lang.Object

com.datadog.api.client.v2.api.DeploymentGatesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeploymentGatesApi.ListDeploymentGatesOptionalParameters Manage optional parameters to listDeploymentGates.

Constructor Summary

Constructors

Constructor and Description
DeploymentGatesApi()
DeploymentGatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DeploymentGateResponse	createDeploymentGate(CreateDeploymentGateParams body) Create deployment gate.
CompletableFuture<DeploymentGateResponse>	createDeploymentGateAsync(CreateDeploymentGateParams body) Create deployment gate.
ApiResponse<DeploymentGateResponse>	createDeploymentGateWithHttpInfo(CreateDeploymentGateParams body) Endpoint to create a deployment gate.
CompletableFuture<ApiResponse<DeploymentGateResponse>>	createDeploymentGateWithHttpInfoAsync(CreateDeploymentGateParams body) Create deployment gate.
DeploymentRuleResponse	createDeploymentRule(String gateId, CreateDeploymentRuleParams body) Create deployment rule.
CompletableFuture<DeploymentRuleResponse>	createDeploymentRuleAsync(String gateId, CreateDeploymentRuleParams body) Create deployment rule.
ApiResponse<DeploymentRuleResponse>	createDeploymentRuleWithHttpInfo(String gateId, CreateDeploymentRuleParams body) Endpoint to create a deployment rule.
CompletableFuture<ApiResponse<DeploymentRuleResponse>>	createDeploymentRuleWithHttpInfoAsync(String gateId, CreateDeploymentRuleParams body) Create deployment rule.
void	deleteDeploymentGate(String id) Delete deployment gate.
CompletableFuture<Void>	deleteDeploymentGateAsync(String id) Delete deployment gate.
ApiResponse<Void>	deleteDeploymentGateWithHttpInfo(String id) Endpoint to delete a deployment gate.
CompletableFuture<ApiResponse<Void>>	deleteDeploymentGateWithHttpInfoAsync(String id) Delete deployment gate.
void	deleteDeploymentRule(String gateId, String id) Delete deployment rule.
CompletableFuture<Void>	deleteDeploymentRuleAsync(String gateId, String id) Delete deployment rule.
ApiResponse<Void>	deleteDeploymentRuleWithHttpInfo(String gateId, String id) Endpoint to delete a deployment rule.
CompletableFuture<ApiResponse<Void>>	deleteDeploymentRuleWithHttpInfoAsync(String gateId, String id) Delete deployment rule.
ApiClient	getApiClient() Get the API client.
DeploymentGateResponse	getDeploymentGate(String id) Get deployment gate.
CompletableFuture<DeploymentGateResponse>	getDeploymentGateAsync(String id) Get deployment gate.
DeploymentGateRulesResponse	getDeploymentGateRules(String gateId) Get rules for a deployment gate.
CompletableFuture<DeploymentGateRulesResponse>	getDeploymentGateRulesAsync(String gateId) Get rules for a deployment gate.
ApiResponse<DeploymentGateRulesResponse>	getDeploymentGateRulesWithHttpInfo(String gateId) Endpoint to get rules for a deployment gate.
CompletableFuture<ApiResponse<DeploymentGateRulesResponse>>	getDeploymentGateRulesWithHttpInfoAsync(String gateId) Get rules for a deployment gate.
DeploymentGatesEvaluationResultResponse	getDeploymentGatesEvaluationResult(UUID id) Get a deployment gate evaluation result.
CompletableFuture<DeploymentGatesEvaluationResultResponse>	getDeploymentGatesEvaluationResultAsync(UUID id) Get a deployment gate evaluation result.
ApiResponse<DeploymentGatesEvaluationResultResponse>	getDeploymentGatesEvaluationResultWithHttpInfo(UUID id) Retrieves the result of a deployment gate evaluation by its evaluation ID.
CompletableFuture<ApiResponse<DeploymentGatesEvaluationResultResponse>>	getDeploymentGatesEvaluationResultWithHttpInfoAsync(UUID id) Get a deployment gate evaluation result.
ApiResponse<DeploymentGateResponse>	getDeploymentGateWithHttpInfo(String id) Endpoint to get a deployment gate.
CompletableFuture<ApiResponse<DeploymentGateResponse>>	getDeploymentGateWithHttpInfoAsync(String id) Get deployment gate.
DeploymentRuleResponse	getDeploymentRule(String gateId, String id) Get deployment rule.
CompletableFuture<DeploymentRuleResponse>	getDeploymentRuleAsync(String gateId, String id) Get deployment rule.
ApiResponse<DeploymentRuleResponse>	getDeploymentRuleWithHttpInfo(String gateId, String id) Endpoint to get a deployment rule.
CompletableFuture<ApiResponse<DeploymentRuleResponse>>	getDeploymentRuleWithHttpInfoAsync(String gateId, String id) Get deployment rule.
DeploymentGatesListResponse	listDeploymentGates() Get all deployment gates.
DeploymentGatesListResponse	listDeploymentGates(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters) Get all deployment gates.
CompletableFuture<DeploymentGatesListResponse>	listDeploymentGatesAsync() Get all deployment gates.
CompletableFuture<DeploymentGatesListResponse>	listDeploymentGatesAsync(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters) Get all deployment gates.
ApiResponse<DeploymentGatesListResponse>	listDeploymentGatesWithHttpInfo(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters) Returns a paginated list of all deployment gates for the organization.
CompletableFuture<ApiResponse<DeploymentGatesListResponse>>	listDeploymentGatesWithHttpInfoAsync(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters) Get all deployment gates.
void	setApiClient(ApiClient apiClient) Set the API client.
DeploymentGatesEvaluationResponse	triggerDeploymentGatesEvaluation(DeploymentGatesEvaluationRequest body) Trigger a deployment gate evaluation.
CompletableFuture<DeploymentGatesEvaluationResponse>	triggerDeploymentGatesEvaluationAsync(DeploymentGatesEvaluationRequest body) Trigger a deployment gate evaluation.
ApiResponse<DeploymentGatesEvaluationResponse>	triggerDeploymentGatesEvaluationWithHttpInfo(DeploymentGatesEvaluationRequest body) Triggers an asynchronous deployment gate evaluation for the given service and environment.
CompletableFuture<ApiResponse<DeploymentGatesEvaluationResponse>>	triggerDeploymentGatesEvaluationWithHttpInfoAsync(DeploymentGatesEvaluationRequest body) Trigger a deployment gate evaluation.
DeploymentGateResponse	updateDeploymentGate(String id, UpdateDeploymentGateParams body) Update deployment gate.
CompletableFuture<DeploymentGateResponse>	updateDeploymentGateAsync(String id, UpdateDeploymentGateParams body) Update deployment gate.
ApiResponse<DeploymentGateResponse>	updateDeploymentGateWithHttpInfo(String id, UpdateDeploymentGateParams body) Endpoint to update a deployment gate.
CompletableFuture<ApiResponse<DeploymentGateResponse>>	updateDeploymentGateWithHttpInfoAsync(String id, UpdateDeploymentGateParams body) Update deployment gate.
DeploymentRuleResponse	updateDeploymentRule(String gateId, String id, UpdateDeploymentRuleParams body) Update deployment rule.
CompletableFuture<DeploymentRuleResponse>	updateDeploymentRuleAsync(String gateId, String id, UpdateDeploymentRuleParams body) Update deployment rule.
ApiResponse<DeploymentRuleResponse>	updateDeploymentRuleWithHttpInfo(String gateId, String id, UpdateDeploymentRuleParams body) Endpoint to update a deployment rule.
CompletableFuture<ApiResponse<DeploymentRuleResponse>>	updateDeploymentRuleWithHttpInfoAsync(String gateId, String id, UpdateDeploymentRuleParams body) Update deployment rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentGatesApi

public DeploymentGatesApi()

DeploymentGatesApi

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

createDeploymentGate

public DeploymentGateResponse createDeploymentGate(CreateDeploymentGateParams body)
                                            throws ApiException

Create deployment gate.

See createDeploymentGateWithHttpInfo(com.datadog.api.client.v2.model.CreateDeploymentGateParams).

Parameters:

body - (required)

Returns:

DeploymentGateResponse

Throws:

ApiException - if fails to make API call

createDeploymentGateAsync

public CompletableFuture<DeploymentGateResponse> createDeploymentGateAsync(CreateDeploymentGateParams body)

Create deployment gate.

See createDeploymentGateWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateDeploymentGateParams).

Parameters:

body - (required)

Returns:

CompletableFuture<DeploymentGateResponse>

createDeploymentGateWithHttpInfo

public ApiResponse<DeploymentGateResponse> createDeploymentGateWithHttpInfo(CreateDeploymentGateParams body)
                                                                     throws ApiException

Endpoint to create a deployment gate.

Parameters:

body - (required)

Returns:

ApiResponse<DeploymentGateResponse>

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	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

createDeploymentGateWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGateResponse>> createDeploymentGateWithHttpInfoAsync(CreateDeploymentGateParams body)

Create deployment gate.

See createDeploymentGateWithHttpInfo(com.datadog.api.client.v2.model.CreateDeploymentGateParams).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGateResponse>>

createDeploymentRule

public DeploymentRuleResponse createDeploymentRule(String gateId,
                                                   CreateDeploymentRuleParams body)
                                            throws ApiException

Create deployment rule.

See createDeploymentRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.CreateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

body - (required)

Returns:

DeploymentRuleResponse

Throws:

ApiException - if fails to make API call

createDeploymentRuleAsync

public CompletableFuture<DeploymentRuleResponse> createDeploymentRuleAsync(String gateId,
                                                                           CreateDeploymentRuleParams body)

Create deployment rule.

See createDeploymentRuleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.CreateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

body - (required)

Returns:

CompletableFuture<DeploymentRuleResponse>

createDeploymentRuleWithHttpInfo

public ApiResponse<DeploymentRuleResponse> createDeploymentRuleWithHttpInfo(String gateId,
                                                                            CreateDeploymentRuleParams body)
                                                                     throws ApiException

Endpoint to create a deployment rule. A gate for the rule must already exist.

Parameters:

gateId - The ID of the deployment gate. (required)

body - (required)

Returns:

ApiResponse<DeploymentRuleResponse>

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	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

createDeploymentRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentRuleResponse>> createDeploymentRuleWithHttpInfoAsync(String gateId,
                                                                                                    CreateDeploymentRuleParams body)

Create deployment rule.

See createDeploymentRuleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.CreateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<DeploymentRuleResponse>>

deleteDeploymentGate

public void deleteDeploymentGate(String id)
                          throws ApiException

Delete deployment gate.

See deleteDeploymentGateWithHttpInfo(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Throws:

ApiException - if fails to make API call

deleteDeploymentGateAsync

public CompletableFuture<Void> deleteDeploymentGateAsync(String id)

Delete deployment gate.

See deleteDeploymentGateWithHttpInfoAsync(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Returns:

CompletableFuture

deleteDeploymentGateWithHttpInfo

public ApiResponse<Void> deleteDeploymentGateWithHttpInfo(String id)
                                                   throws ApiException

Endpoint to delete a deployment gate. Rules associated with the gate are also deleted.

Parameters:

id - The ID of the deployment gate. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad request.	-
401	Unauthorized	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

deleteDeploymentGateWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDeploymentGateWithHttpInfoAsync(String id)

Delete deployment gate.

See deleteDeploymentGateWithHttpInfo(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deleteDeploymentRule

public void deleteDeploymentRule(String gateId,
                                 String id)
                          throws ApiException

Delete deployment rule.

See deleteDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Throws:

ApiException - if fails to make API call

deleteDeploymentRuleAsync

public CompletableFuture<Void> deleteDeploymentRuleAsync(String gateId,
                                                         String id)

Delete deployment rule.

See deleteDeploymentRuleWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

CompletableFuture

deleteDeploymentRuleWithHttpInfo

public ApiResponse<Void> deleteDeploymentRuleWithHttpInfo(String gateId,
                                                          String id)
                                                   throws ApiException

Endpoint to delete a deployment rule.

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad request.	-
401	Unauthorized	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

deleteDeploymentRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDeploymentRuleWithHttpInfoAsync(String gateId,
                                                                                  String id)

Delete deployment rule.

See deleteDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getDeploymentGate

public DeploymentGateResponse getDeploymentGate(String id)
                                         throws ApiException

Get deployment gate.

See getDeploymentGateWithHttpInfo(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Returns:

DeploymentGateResponse

Throws:

ApiException - if fails to make API call

getDeploymentGateAsync

public CompletableFuture<DeploymentGateResponse> getDeploymentGateAsync(String id)

Get deployment gate.

See getDeploymentGateWithHttpInfoAsync(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Returns:

CompletableFuture<DeploymentGateResponse>

getDeploymentGateWithHttpInfo

public ApiResponse<DeploymentGateResponse> getDeploymentGateWithHttpInfo(String id)
                                                                  throws ApiException

Endpoint to get a deployment gate.

Parameters:

id - The ID of the deployment gate. (required)

Returns:

ApiResponse<DeploymentGateResponse>

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	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

getDeploymentGateWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGateResponse>> getDeploymentGateWithHttpInfoAsync(String id)

Get deployment gate.

See getDeploymentGateWithHttpInfo(java.lang.String).

Parameters:

id - The ID of the deployment gate. (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGateResponse>>

getDeploymentGateRules

public DeploymentGateRulesResponse getDeploymentGateRules(String gateId)
                                                   throws ApiException

Get rules for a deployment gate.

See getDeploymentGateRulesWithHttpInfo(java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

Returns:

DeploymentGateRulesResponse

Throws:

ApiException - if fails to make API call

getDeploymentGateRulesAsync

public CompletableFuture<DeploymentGateRulesResponse> getDeploymentGateRulesAsync(String gateId)

Get rules for a deployment gate.

See getDeploymentGateRulesWithHttpInfoAsync(java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

Returns:

CompletableFuture<DeploymentGateRulesResponse>

getDeploymentGateRulesWithHttpInfo

public ApiResponse<DeploymentGateRulesResponse> getDeploymentGateRulesWithHttpInfo(String gateId)
                                                                            throws ApiException

Endpoint to get rules for a deployment gate.

Parameters:

gateId - The ID of the deployment gate. (required)

Returns:

ApiResponse<DeploymentGateRulesResponse>

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	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

getDeploymentGateRulesWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGateRulesResponse>> getDeploymentGateRulesWithHttpInfoAsync(String gateId)

Get rules for a deployment gate.

See getDeploymentGateRulesWithHttpInfo(java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGateRulesResponse>>

getDeploymentGatesEvaluationResult

public DeploymentGatesEvaluationResultResponse getDeploymentGatesEvaluationResult(UUID id)
                                                                           throws ApiException

Get a deployment gate evaluation result.

See getDeploymentGatesEvaluationResultWithHttpInfo(java.util.UUID).

Parameters:

id - The evaluation ID returned by the trigger endpoint. (required)

Returns:

DeploymentGatesEvaluationResultResponse

Throws:

ApiException - if fails to make API call

getDeploymentGatesEvaluationResultAsync

public CompletableFuture<DeploymentGatesEvaluationResultResponse> getDeploymentGatesEvaluationResultAsync(UUID id)

Get a deployment gate evaluation result.

See getDeploymentGatesEvaluationResultWithHttpInfoAsync(java.util.UUID).

Parameters:

id - The evaluation ID returned by the trigger endpoint. (required)

Returns:

CompletableFuture<DeploymentGatesEvaluationResultResponse>

getDeploymentGatesEvaluationResultWithHttpInfo

public ApiResponse<DeploymentGatesEvaluationResultResponse> getDeploymentGatesEvaluationResultWithHttpInfo(UUID id)
                                                                                                    throws ApiException

Retrieves the result of a deployment gate evaluation by its evaluation ID. If the evaluation is still in progress, data.attributes.gate_status will be in_progress; continue polling until it returns pass or fail. Polling every 10-20 seconds is recommended. The endpoint may return a 404 if called too soon after triggering; retry after a few seconds.

Parameters:

id - The evaluation ID returned by the trigger endpoint. (required)

Returns:

ApiResponse<DeploymentGatesEvaluationResultResponse>

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	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

getDeploymentGatesEvaluationResultWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGatesEvaluationResultResponse>> getDeploymentGatesEvaluationResultWithHttpInfoAsync(UUID id)

Get a deployment gate evaluation result.

See getDeploymentGatesEvaluationResultWithHttpInfo(java.util.UUID).

Parameters:

id - The evaluation ID returned by the trigger endpoint. (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGatesEvaluationResultResponse>>

getDeploymentRule

public DeploymentRuleResponse getDeploymentRule(String gateId,
                                                String id)
                                         throws ApiException

Get deployment rule.

See getDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

DeploymentRuleResponse

Throws:

ApiException - if fails to make API call

getDeploymentRuleAsync

public CompletableFuture<DeploymentRuleResponse> getDeploymentRuleAsync(String gateId,
                                                                        String id)

Get deployment rule.

See getDeploymentRuleWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

CompletableFuture<DeploymentRuleResponse>

getDeploymentRuleWithHttpInfo

public ApiResponse<DeploymentRuleResponse> getDeploymentRuleWithHttpInfo(String gateId,
                                                                         String id)
                                                                  throws ApiException

Endpoint to get a deployment rule.

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

ApiResponse<DeploymentRuleResponse>

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	-
403	Forbidden	-
404	Deployment rule not found.	-
429	Too many requests	-
500	Internal Server Error	-

getDeploymentRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentRuleResponse>> getDeploymentRuleWithHttpInfoAsync(String gateId,
                                                                                                 String id)

Get deployment rule.

See getDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

Returns:

CompletableFuture<ApiResponse<DeploymentRuleResponse>>

listDeploymentGates

public DeploymentGatesListResponse listDeploymentGates()
                                                throws ApiException

Get all deployment gates.

See listDeploymentGatesWithHttpInfo(com.datadog.api.client.v2.api.DeploymentGatesApi.ListDeploymentGatesOptionalParameters).

Returns:

DeploymentGatesListResponse

Throws:

ApiException - if fails to make API call

listDeploymentGatesAsync

public CompletableFuture<DeploymentGatesListResponse> listDeploymentGatesAsync()

Get all deployment gates.

See listDeploymentGatesWithHttpInfoAsync(com.datadog.api.client.v2.api.DeploymentGatesApi.ListDeploymentGatesOptionalParameters).

Returns:

CompletableFuture<DeploymentGatesListResponse>

listDeploymentGates

public DeploymentGatesListResponse listDeploymentGates(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters)
                                                throws ApiException

Get all deployment gates.

See listDeploymentGatesWithHttpInfo(com.datadog.api.client.v2.api.DeploymentGatesApi.ListDeploymentGatesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

DeploymentGatesListResponse

Throws:

ApiException - if fails to make API call

listDeploymentGatesAsync

public CompletableFuture<DeploymentGatesListResponse> listDeploymentGatesAsync(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters)

Get all deployment gates.

See listDeploymentGatesWithHttpInfoAsync(com.datadog.api.client.v2.api.DeploymentGatesApi.ListDeploymentGatesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<DeploymentGatesListResponse>

listDeploymentGatesWithHttpInfo

public ApiResponse<DeploymentGatesListResponse> listDeploymentGatesWithHttpInfo(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters)
                                                                         throws ApiException

Returns a paginated list of all deployment gates for the organization. Use page[cursor] and page[size] query parameters to paginate through results.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<DeploymentGatesListResponse>

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	-
403	Forbidden	-
429	Too many requests	-
500	Internal Server Error	-

listDeploymentGatesWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGatesListResponse>> listDeploymentGatesWithHttpInfoAsync(DeploymentGatesApi.ListDeploymentGatesOptionalParameters parameters)

Get all deployment gates.

See listDeploymentGatesWithHttpInfo(com.datadog.api.client.v2.api.DeploymentGatesApi.ListDeploymentGatesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<DeploymentGatesListResponse>>

triggerDeploymentGatesEvaluation

public DeploymentGatesEvaluationResponse triggerDeploymentGatesEvaluation(DeploymentGatesEvaluationRequest body)
                                                                   throws ApiException

Trigger a deployment gate evaluation.

See triggerDeploymentGatesEvaluationWithHttpInfo(com.datadog.api.client.v2.model.DeploymentGatesEvaluationRequest).

Parameters:

body - (required)

Returns:

DeploymentGatesEvaluationResponse

Throws:

ApiException - if fails to make API call

triggerDeploymentGatesEvaluationAsync

public CompletableFuture<DeploymentGatesEvaluationResponse> triggerDeploymentGatesEvaluationAsync(DeploymentGatesEvaluationRequest body)

Trigger a deployment gate evaluation.

See triggerDeploymentGatesEvaluationWithHttpInfoAsync(com.datadog.api.client.v2.model.DeploymentGatesEvaluationRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DeploymentGatesEvaluationResponse>

triggerDeploymentGatesEvaluationWithHttpInfo

public ApiResponse<DeploymentGatesEvaluationResponse> triggerDeploymentGatesEvaluationWithHttpInfo(DeploymentGatesEvaluationRequest body)
                                                                                            throws ApiException

Triggers an asynchronous deployment gate evaluation for the given service and environment. Returns an evaluation ID that can be used to poll for the result via the GET /api/v2/deployments/gates/evaluation/{id} endpoint.

When the configuration attribute is provided, rules are evaluated inline from that configuration and no pre-configured gate is required. When configuration is omitted, rules are resolved from the gate pre-configured for the given service and environment through the Datadog UI, API, or Terraform.

Parameters:

body - (required)

Returns:

ApiResponse<DeploymentGatesEvaluationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Accepted	-
400	Bad request.	-
401	Unauthorized	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

triggerDeploymentGatesEvaluationWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGatesEvaluationResponse>> triggerDeploymentGatesEvaluationWithHttpInfoAsync(DeploymentGatesEvaluationRequest body)

Trigger a deployment gate evaluation.

See triggerDeploymentGatesEvaluationWithHttpInfo(com.datadog.api.client.v2.model.DeploymentGatesEvaluationRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGatesEvaluationResponse>>

updateDeploymentGate

public DeploymentGateResponse updateDeploymentGate(String id,
                                                   UpdateDeploymentGateParams body)
                                            throws ApiException

Update deployment gate.

See updateDeploymentGateWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentGateParams).

Parameters:

id - The ID of the deployment gate. (required)

body - (required)

Returns:

DeploymentGateResponse

Throws:

ApiException - if fails to make API call

updateDeploymentGateAsync

public CompletableFuture<DeploymentGateResponse> updateDeploymentGateAsync(String id,
                                                                           UpdateDeploymentGateParams body)

Update deployment gate.

See updateDeploymentGateWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentGateParams).

Parameters:

id - The ID of the deployment gate. (required)

body - (required)

Returns:

CompletableFuture<DeploymentGateResponse>

updateDeploymentGateWithHttpInfo

public ApiResponse<DeploymentGateResponse> updateDeploymentGateWithHttpInfo(String id,
                                                                            UpdateDeploymentGateParams body)
                                                                     throws ApiException

Endpoint to update a deployment gate.

Parameters:

id - The ID of the deployment gate. (required)

body - (required)

Returns:

ApiResponse<DeploymentGateResponse>

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	-
403	Forbidden	-
404	Deployment gate not found.	-
429	Too many requests	-
500	Internal Server Error	-

updateDeploymentGateWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentGateResponse>> updateDeploymentGateWithHttpInfoAsync(String id,
                                                                                                    UpdateDeploymentGateParams body)

Update deployment gate.

See updateDeploymentGateWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentGateParams).

Parameters:

id - The ID of the deployment gate. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<DeploymentGateResponse>>

updateDeploymentRule

public DeploymentRuleResponse updateDeploymentRule(String gateId,
                                                   String id,
                                                   UpdateDeploymentRuleParams body)
                                            throws ApiException

Update deployment rule.

See updateDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

body - (required)

Returns:

DeploymentRuleResponse

Throws:

ApiException - if fails to make API call

updateDeploymentRuleAsync

public CompletableFuture<DeploymentRuleResponse> updateDeploymentRuleAsync(String gateId,
                                                                           String id,
                                                                           UpdateDeploymentRuleParams body)

Update deployment rule.

See updateDeploymentRuleWithHttpInfoAsync(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

body - (required)

Returns:

CompletableFuture<DeploymentRuleResponse>

updateDeploymentRuleWithHttpInfo

public ApiResponse<DeploymentRuleResponse> updateDeploymentRuleWithHttpInfo(String gateId,
                                                                            String id,
                                                                            UpdateDeploymentRuleParams body)
                                                                     throws ApiException

Endpoint to update a deployment rule.

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

body - (required)

Returns:

ApiResponse<DeploymentRuleResponse>

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	-
403	Forbidden	-
404	Deployment rule not found.	-
429	Too many requests	-
500	Internal Server Error	-

updateDeploymentRuleWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeploymentRuleResponse>> updateDeploymentRuleWithHttpInfoAsync(String gateId,
                                                                                                    String id,
                                                                                                    UpdateDeploymentRuleParams body)

Update deployment rule.

See updateDeploymentRuleWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.UpdateDeploymentRuleParams).

Parameters:

gateId - The ID of the deployment gate. (required)

id - The ID of the deployment rule. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<DeploymentRuleResponse>>