Package com.datadog.api.client.v2.api
Class SensitiveDataScannerApi
java.lang.Object
com.datadog.api.client.v2.api.SensitiveDataScannerApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SensitiveDataScannerApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate Scanning Group.Create Scanning Group.Create a scanning group.Create Scanning Group.Create Scanning Rule.Create Scanning Rule.Create a scanning rule in a sensitive data scanner group, ordered last.Create Scanning Rule.deleteScanningGroup(String groupId, SensitiveDataScannerGroupDeleteRequest body) Delete Scanning Group.deleteScanningGroupAsync(String groupId, SensitiveDataScannerGroupDeleteRequest body) Delete Scanning Group.Delete a given group.Delete Scanning Group.deleteScanningRule(String ruleId, SensitiveDataScannerRuleDeleteRequest body) Delete Scanning Rule.Delete Scanning Rule.Delete a given rule.Delete Scanning Rule.Get the API client.List Scanning Groups.List Scanning Groups.List all the Scanning groups in your organization.List Scanning Groups.List standard patterns.List standard patterns.Returns all standard patterns.List standard patterns.Reorder Groups.Reorder Groups.Reorder the list of groups.Reorder Groups.voidsetApiClient(ApiClient apiClient) Set the API client.updateScanningGroup(String groupId, SensitiveDataScannerGroupUpdateRequest body) Update Scanning Group.updateScanningGroupAsync(String groupId, SensitiveDataScannerGroupUpdateRequest body) Update Scanning Group.Update a group, including the order of the rules.Update Scanning Group.updateScanningRule(String ruleId, SensitiveDataScannerRuleUpdateRequest body) Update Scanning Rule.Update Scanning Rule.Update a scanning rule.Update Scanning Rule.
-
Constructor Details
-
SensitiveDataScannerApi
public SensitiveDataScannerApi() -
SensitiveDataScannerApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
createScanningGroup
public SensitiveDataScannerCreateGroupResponse createScanningGroup(SensitiveDataScannerGroupCreateRequest body) throws ApiException Create Scanning Group.- Parameters:
body- (required)- Returns:
- SensitiveDataScannerCreateGroupResponse
- Throws:
ApiException- if fails to make API call
-
createScanningGroupAsync
public CompletableFuture<SensitiveDataScannerCreateGroupResponse> createScanningGroupAsync(SensitiveDataScannerGroupCreateRequest body) Create Scanning Group.- Parameters:
body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerCreateGroupResponse>
-
createScanningGroupWithHttpInfo
public ApiResponse<SensitiveDataScannerCreateGroupResponse> createScanningGroupWithHttpInfo(SensitiveDataScannerGroupCreateRequest body) throws ApiException Create a scanning group. The request MAY include a configuration relationship. A rules relationship can be omitted entirely, but if it is included it MUST be null or an empty array (rules cannot be created at the same time). The new group will be ordered last within the configuration.- Parameters:
body- (required)- Returns:
- ApiResponse<SensitiveDataScannerCreateGroupResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 OK - 400 Bad Request - 403 Authentication Error - 429 Too many requests -
-
createScanningGroupWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerCreateGroupResponse>> createScanningGroupWithHttpInfoAsync(SensitiveDataScannerGroupCreateRequest body) Create Scanning Group.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerCreateGroupResponse>>
-
createScanningRule
public SensitiveDataScannerCreateRuleResponse createScanningRule(SensitiveDataScannerRuleCreateRequest body) throws ApiException Create Scanning Rule.- Parameters:
body- (required)- Returns:
- SensitiveDataScannerCreateRuleResponse
- Throws:
ApiException- if fails to make API call
-
createScanningRuleAsync
public CompletableFuture<SensitiveDataScannerCreateRuleResponse> createScanningRuleAsync(SensitiveDataScannerRuleCreateRequest body) Create Scanning Rule.- Parameters:
body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerCreateRuleResponse>
-
createScanningRuleWithHttpInfo
public ApiResponse<SensitiveDataScannerCreateRuleResponse> createScanningRuleWithHttpInfo(SensitiveDataScannerRuleCreateRequest body) throws ApiException Create a scanning rule in a sensitive data scanner group, ordered last. The posted rule MUST include a group relationship. It MUST include either a standard_pattern relationship or a regex attribute, but not both. If included_attributes is empty or missing, we will scan all attributes except excluded_attributes. If both are missing, we will scan the whole event.- Parameters:
body- (required)- Returns:
- ApiResponse<SensitiveDataScannerCreateRuleResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 201 OK - 400 Bad Request - 403 Authentication Error - 429 Too many requests -
-
createScanningRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerCreateRuleResponse>> createScanningRuleWithHttpInfoAsync(SensitiveDataScannerRuleCreateRequest body) Create Scanning Rule.- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerCreateRuleResponse>>
-
deleteScanningGroup
public SensitiveDataScannerGroupDeleteResponse deleteScanningGroup(String groupId, SensitiveDataScannerGroupDeleteRequest body) throws ApiException Delete Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- SensitiveDataScannerGroupDeleteResponse
- Throws:
ApiException- if fails to make API call
-
deleteScanningGroupAsync
public CompletableFuture<SensitiveDataScannerGroupDeleteResponse> deleteScanningGroupAsync(String groupId, SensitiveDataScannerGroupDeleteRequest body) Delete Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerGroupDeleteResponse>
-
deleteScanningGroupWithHttpInfo
public ApiResponse<SensitiveDataScannerGroupDeleteResponse> deleteScanningGroupWithHttpInfo(String groupId, SensitiveDataScannerGroupDeleteRequest body) throws ApiException Delete a given group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- ApiResponse<SensitiveDataScannerGroupDeleteResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Not Found - 429 Too many requests -
-
deleteScanningGroupWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerGroupDeleteResponse>> deleteScanningGroupWithHttpInfoAsync(String groupId, SensitiveDataScannerGroupDeleteRequest body) Delete Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerGroupDeleteResponse>>
-
deleteScanningRule
public SensitiveDataScannerRuleDeleteResponse deleteScanningRule(String ruleId, SensitiveDataScannerRuleDeleteRequest body) throws ApiException Delete Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- SensitiveDataScannerRuleDeleteResponse
- Throws:
ApiException- if fails to make API call
-
deleteScanningRuleAsync
public CompletableFuture<SensitiveDataScannerRuleDeleteResponse> deleteScanningRuleAsync(String ruleId, SensitiveDataScannerRuleDeleteRequest body) Delete Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerRuleDeleteResponse>
-
deleteScanningRuleWithHttpInfo
public ApiResponse<SensitiveDataScannerRuleDeleteResponse> deleteScanningRuleWithHttpInfo(String ruleId, SensitiveDataScannerRuleDeleteRequest body) throws ApiException Delete a given rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- ApiResponse<SensitiveDataScannerRuleDeleteResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Not Found - 429 Too many requests -
-
deleteScanningRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerRuleDeleteResponse>> deleteScanningRuleWithHttpInfoAsync(String ruleId, SensitiveDataScannerRuleDeleteRequest body) Delete Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerRuleDeleteResponse>>
-
listScanningGroups
List Scanning Groups.- Returns:
- SensitiveDataScannerGetConfigResponse
- Throws:
ApiException- if fails to make API call
-
listScanningGroupsAsync
List Scanning Groups.- Returns:
- CompletableFuture<SensitiveDataScannerGetConfigResponse>
-
listScanningGroupsWithHttpInfo
public ApiResponse<SensitiveDataScannerGetConfigResponse> listScanningGroupsWithHttpInfo() throws ApiExceptionList all the Scanning groups in your organization.- Returns:
- ApiResponse<SensitiveDataScannerGetConfigResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 429 Too many requests -
-
listScanningGroupsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerGetConfigResponse>> listScanningGroupsWithHttpInfoAsync()List Scanning Groups.- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerGetConfigResponse>>
-
listStandardPatterns
List standard patterns.- Returns:
- SensitiveDataScannerStandardPatternsResponseData
- Throws:
ApiException- if fails to make API call
-
listStandardPatternsAsync
public CompletableFuture<SensitiveDataScannerStandardPatternsResponseData> listStandardPatternsAsync()List standard patterns.- Returns:
- CompletableFuture<SensitiveDataScannerStandardPatternsResponseData>
-
listStandardPatternsWithHttpInfo
public ApiResponse<SensitiveDataScannerStandardPatternsResponseData> listStandardPatternsWithHttpInfo() throws ApiExceptionReturns all standard patterns.- Returns:
- ApiResponse<SensitiveDataScannerStandardPatternsResponseData>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 429 Too many requests -
-
listStandardPatternsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerStandardPatternsResponseData>> listStandardPatternsWithHttpInfoAsync()List standard patterns.- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerStandardPatternsResponseData>>
-
reorderScanningGroups
public SensitiveDataScannerReorderGroupsResponse reorderScanningGroups(SensitiveDataScannerConfigRequest body) throws ApiException Reorder Groups.See
reorderScanningGroupsWithHttpInfo(com.datadog.api.client.v2.model.SensitiveDataScannerConfigRequest).- Parameters:
body- (required)- Returns:
- SensitiveDataScannerReorderGroupsResponse
- Throws:
ApiException- if fails to make API call
-
reorderScanningGroupsAsync
public CompletableFuture<SensitiveDataScannerReorderGroupsResponse> reorderScanningGroupsAsync(SensitiveDataScannerConfigRequest body) Reorder Groups.- Parameters:
body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerReorderGroupsResponse>
-
reorderScanningGroupsWithHttpInfo
public ApiResponse<SensitiveDataScannerReorderGroupsResponse> reorderScanningGroupsWithHttpInfo(SensitiveDataScannerConfigRequest body) throws ApiException Reorder the list of groups.- Parameters:
body- (required)- Returns:
- ApiResponse<SensitiveDataScannerReorderGroupsResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 429 Too many requests -
-
reorderScanningGroupsWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerReorderGroupsResponse>> reorderScanningGroupsWithHttpInfoAsync(SensitiveDataScannerConfigRequest body) Reorder Groups.See
reorderScanningGroupsWithHttpInfo(com.datadog.api.client.v2.model.SensitiveDataScannerConfigRequest).- Parameters:
body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerReorderGroupsResponse>>
-
updateScanningGroup
public SensitiveDataScannerGroupUpdateResponse updateScanningGroup(String groupId, SensitiveDataScannerGroupUpdateRequest body) throws ApiException Update Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- SensitiveDataScannerGroupUpdateResponse
- Throws:
ApiException- if fails to make API call
-
updateScanningGroupAsync
public CompletableFuture<SensitiveDataScannerGroupUpdateResponse> updateScanningGroupAsync(String groupId, SensitiveDataScannerGroupUpdateRequest body) Update Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerGroupUpdateResponse>
-
updateScanningGroupWithHttpInfo
public ApiResponse<SensitiveDataScannerGroupUpdateResponse> updateScanningGroupWithHttpInfo(String groupId, SensitiveDataScannerGroupUpdateRequest body) throws ApiException Update a group, including the order of the rules. Rules within the group are reordered by including a rules relationship. If the rules relationship is present, its data section MUST contain linkages for all of the rules currently in the group, and MUST NOT contain any others.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- ApiResponse<SensitiveDataScannerGroupUpdateResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Not Found - 429 Too many requests -
-
updateScanningGroupWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerGroupUpdateResponse>> updateScanningGroupWithHttpInfoAsync(String groupId, SensitiveDataScannerGroupUpdateRequest body) Update Scanning Group.- Parameters:
groupId- The ID of a group of rules. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerGroupUpdateResponse>>
-
updateScanningRule
public SensitiveDataScannerRuleUpdateResponse updateScanningRule(String ruleId, SensitiveDataScannerRuleUpdateRequest body) throws ApiException Update Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- SensitiveDataScannerRuleUpdateResponse
- Throws:
ApiException- if fails to make API call
-
updateScanningRuleAsync
public CompletableFuture<SensitiveDataScannerRuleUpdateResponse> updateScanningRuleAsync(String ruleId, SensitiveDataScannerRuleUpdateRequest body) Update Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- CompletableFuture<SensitiveDataScannerRuleUpdateResponse>
-
updateScanningRuleWithHttpInfo
public ApiResponse<SensitiveDataScannerRuleUpdateResponse> updateScanningRuleWithHttpInfo(String ruleId, SensitiveDataScannerRuleUpdateRequest body) throws ApiException Update a scanning rule. The request body MUST NOT include a standard_pattern relationship, as that relationship is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern relationship will also result in an error.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- ApiResponse<SensitiveDataScannerRuleUpdateResponse>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 200 OK - 400 Bad Request - 403 Authentication Error - 404 Not Found - 429 Too many requests -
-
updateScanningRuleWithHttpInfoAsync
public CompletableFuture<ApiResponse<SensitiveDataScannerRuleUpdateResponse>> updateScanningRuleWithHttpInfoAsync(String ruleId, SensitiveDataScannerRuleUpdateRequest body) Update Scanning Rule.- Parameters:
ruleId- The ID of the rule. (required)body- (required)- Returns:
- CompletableFuture<ApiResponse<SensitiveDataScannerRuleUpdateResponse>>
-