com.datadog.api.client.v2.api

Class RestrictionPoliciesApi

java.lang.Object

com.datadog.api.client.v2.api.RestrictionPoliciesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters Manage optional parameters to updateRestrictionPolicy.

Constructor Summary

Constructors

Constructor and Description
RestrictionPoliciesApi()
RestrictionPoliciesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteRestrictionPolicy(String resourceId) Delete a restriction policy.
CompletableFuture<Void>	deleteRestrictionPolicyAsync(String resourceId) Delete a restriction policy.
ApiResponse<Void>	deleteRestrictionPolicyWithHttpInfo(String resourceId) Deletes the restriction policy associated with a specified resource.
CompletableFuture<ApiResponse<Void>>	deleteRestrictionPolicyWithHttpInfoAsync(String resourceId) Delete a restriction policy.
ApiClient	getApiClient() Get the API client.
RestrictionPolicyResponse	getRestrictionPolicy(String resourceId) Get a restriction policy.
CompletableFuture<RestrictionPolicyResponse>	getRestrictionPolicyAsync(String resourceId) Get a restriction policy.
ApiResponse<RestrictionPolicyResponse>	getRestrictionPolicyWithHttpInfo(String resourceId) Retrieves the restriction policy associated with a specified resource.
CompletableFuture<ApiResponse<RestrictionPolicyResponse>>	getRestrictionPolicyWithHttpInfoAsync(String resourceId) Get a restriction policy.
void	setApiClient(ApiClient apiClient) Set the API client.
RestrictionPolicyResponse	updateRestrictionPolicy(String resourceId, RestrictionPolicyUpdateRequest body) Update a restriction policy.
RestrictionPolicyResponse	updateRestrictionPolicy(String resourceId, RestrictionPolicyUpdateRequest body, RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters) Update a restriction policy.
CompletableFuture<RestrictionPolicyResponse>	updateRestrictionPolicyAsync(String resourceId, RestrictionPolicyUpdateRequest body) Update a restriction policy.
CompletableFuture<RestrictionPolicyResponse>	updateRestrictionPolicyAsync(String resourceId, RestrictionPolicyUpdateRequest body, RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters) Update a restriction policy.
ApiResponse<RestrictionPolicyResponse>	updateRestrictionPolicyWithHttpInfo(String resourceId, RestrictionPolicyUpdateRequest body, RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters) Updates the restriction policy associated with a resource.
CompletableFuture<ApiResponse<RestrictionPolicyResponse>>	updateRestrictionPolicyWithHttpInfoAsync(String resourceId, RestrictionPolicyUpdateRequest body, RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters) Update a restriction policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestrictionPoliciesApi

public RestrictionPoliciesApi()

RestrictionPoliciesApi

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

deleteRestrictionPolicy

public void deleteRestrictionPolicy(String resourceId)
                             throws ApiException

Delete a restriction policy.

See deleteRestrictionPolicyWithHttpInfo(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Throws:

ApiException - if fails to make API call

deleteRestrictionPolicyAsync

public CompletableFuture<Void> deleteRestrictionPolicyAsync(String resourceId)

Delete a restriction policy.

See deleteRestrictionPolicyWithHttpInfoAsync(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

CompletableFuture

deleteRestrictionPolicyWithHttpInfo

public ApiResponse<Void> deleteRestrictionPolicyWithHttpInfo(String resourceId)
                                                      throws ApiException

Deletes the restriction policy associated with a specified resource.

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (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	-
403	Not Authorized	-
429	Too many requests	-

deleteRestrictionPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteRestrictionPolicyWithHttpInfoAsync(String resourceId)

Delete a restriction policy.

See deleteRestrictionPolicyWithHttpInfo(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getRestrictionPolicy

public RestrictionPolicyResponse getRestrictionPolicy(String resourceId)
                                               throws ApiException

Get a restriction policy.

See getRestrictionPolicyWithHttpInfo(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

RestrictionPolicyResponse

Throws:

ApiException - if fails to make API call

getRestrictionPolicyAsync

public CompletableFuture<RestrictionPolicyResponse> getRestrictionPolicyAsync(String resourceId)

Get a restriction policy.

See getRestrictionPolicyWithHttpInfoAsync(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

CompletableFuture<RestrictionPolicyResponse>

getRestrictionPolicyWithHttpInfo

public ApiResponse<RestrictionPolicyResponse> getRestrictionPolicyWithHttpInfo(String resourceId)
                                                                        throws ApiException

Retrieves the restriction policy associated with a specified resource.

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

ApiResponse<RestrictionPolicyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getRestrictionPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<RestrictionPolicyResponse>> getRestrictionPolicyWithHttpInfoAsync(String resourceId)

Get a restriction policy.

See getRestrictionPolicyWithHttpInfo(java.lang.String).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

Returns:

CompletableFuture<ApiResponse<RestrictionPolicyResponse>>

updateRestrictionPolicy

public RestrictionPolicyResponse updateRestrictionPolicy(String resourceId,
                                                         RestrictionPolicyUpdateRequest body)
                                                  throws ApiException

Update a restriction policy.

See updateRestrictionPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest, com.datadog.api.client.v2.api.RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

Returns:

RestrictionPolicyResponse

Throws:

ApiException - if fails to make API call

updateRestrictionPolicyAsync

public CompletableFuture<RestrictionPolicyResponse> updateRestrictionPolicyAsync(String resourceId,
                                                                                 RestrictionPolicyUpdateRequest body)

Update a restriction policy.

See updateRestrictionPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest, com.datadog.api.client.v2.api.RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

Returns:

CompletableFuture<RestrictionPolicyResponse>

updateRestrictionPolicy

public RestrictionPolicyResponse updateRestrictionPolicy(String resourceId,
                                                         RestrictionPolicyUpdateRequest body,
                                                         RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters)
                                                  throws ApiException

Update a restriction policy.

See updateRestrictionPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest, com.datadog.api.client.v2.api.RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

parameters - Optional parameters for the request.

Returns:

RestrictionPolicyResponse

Throws:

ApiException - if fails to make API call

updateRestrictionPolicyAsync

public CompletableFuture<RestrictionPolicyResponse> updateRestrictionPolicyAsync(String resourceId,
                                                                                 RestrictionPolicyUpdateRequest body,
                                                                                 RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters)

Update a restriction policy.

See updateRestrictionPolicyWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest, com.datadog.api.client.v2.api.RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RestrictionPolicyResponse>

updateRestrictionPolicyWithHttpInfo

public ApiResponse<RestrictionPolicyResponse> updateRestrictionPolicyWithHttpInfo(String resourceId,
                                                                                  RestrictionPolicyUpdateRequest body,
                                                                                  RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters)
                                                                           throws ApiException

Updates the restriction policy associated with a resource.

Supported resources

Restriction policies can be applied to the following resources: - Dashboards: dashboard - Integration Services: integration-service - Integration Webhooks: integration-webhook - Notebooks: notebook - Powerpacks: powerpack - Reference Tables: reference-table - Security Rules: security-rule - Service Level Objectives: slo - Synthetic Global Variables: synthetics-global-variable - Synthetic Tests: synthetics-test - Synthetic Private Locations: synthetics-private-location - Monitors: monitor - Workflows: workflow - App Builder Apps: app-builder-app - Connections: connection - Connection Groups: connection-group - RUM Applications: rum-application - Cross Org Connections: cross-org-connection - Spreadsheets: spreadsheet - On-Call Schedules: on-call-schedule - On-Call Escalation Policies: on-call-escalation-policy - On-Call Team Routing Rules: on-call-team-routing-rules - Logs Pipelines: logs-pipeline - Case Management Projects: case-management-project - Monitor Notification Rules: monitor-notification-rule - Status Pages: status-page

Supported relations for resources

Resource Type | Supported Relations ----------------------------|-------------------------- Dashboards | viewer, editor Integration Services | viewer , editor Integration Webhooks | viewer, editor Notebooks | viewer, editor Powerpacks | viewer, editor Security Rules | viewer, editor Service Level Objectives | viewer, editor Synthetic Global Variables | viewer , editor Synthetic Tests | viewer, editor Synthetic Private Locations | viewer, editor Monitors | viewer , editor Reference Tables | viewer, editor Workflows | viewer, runner, editor App Builder Apps | viewer, editor Connections | viewer, resolver , editor Connection Groups | viewer, editor RUM Application | viewer, editor Cross Org Connections | viewer , editor Spreadsheets | viewer, editor On-Call Schedules | viewer, overrider, editor On-Call Escalation Policies | viewer, editor On-Call Team Routing Rules | viewer , editor Logs Pipelines | viewer, processors_editor , editor Case Management Projects | viewer, contributor , manager Monitor Notification Rules | viewer, editor Status Pages | viewer, responder, manager

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<RestrictionPolicyResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

updateRestrictionPolicyWithHttpInfoAsync

public CompletableFuture<ApiResponse<RestrictionPolicyResponse>> updateRestrictionPolicyWithHttpInfoAsync(String resourceId,
                                                                                                          RestrictionPolicyUpdateRequest body,
                                                                                                          RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters parameters)

Update a restriction policy.

See updateRestrictionPolicyWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RestrictionPolicyUpdateRequest, com.datadog.api.client.v2.api.RestrictionPoliciesApi.UpdateRestrictionPolicyOptionalParameters).

Parameters:

resourceId - Identifier, formatted as type:id. Supported types: dashboard, integration-service, integration-webhook, notebook, powerpack, reference-table, security-rule, slo, synthetics-global-variable, synthetics-test, synthetics-private-location, monitor, workflow, app-builder-app, connection, connection-group, rum-application, cross-org-connection, spreadsheet, on-call-schedule, on-call-escalation-policy , on-call-team-routing-rules, logs-pipeline, case-management-project, monitor-notification-rule, status-page . (required)

body - Restriction policy payload (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RestrictionPolicyResponse>>