Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

docs(samples): included snippet for unmute finding #794

Merged
merged 5 commits into from
Mar 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .kokoro/presubmit/samples.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ env_vars: {

env_vars: {
key: "SECRET_MANAGER_KEYS"
value: "java-docs-samples-service-account"
value: "java-docs-samples-service-account,java-scc-samples-secrets"
}
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ implementation 'com.google.cloud:google-cloud-securitycenter'
If you are using Gradle without BOM, add this to your dependencies

```Groovy
implementation 'com.google.cloud:google-cloud-securitycenter:2.5.2'
implementation 'com.google.cloud:google-cloud-securitycenter:2.5.3'
```

If you are using SBT, add this to your dependencies

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-securitycenter" % "2.5.2"
libraryDependencies += "com.google.cloud" % "google-cloud-securitycenter" % "2.5.3"
```

## Authentication
Expand Down Expand Up @@ -123,7 +123,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-securitycente
| Delete Mute Rule | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/DeleteMuteRule.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/DeleteMuteRule.java) |
| Get Mute Rule | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/GetMuteRule.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/GetMuteRule.java) |
| List Mute Rules | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/ListMuteRules.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/ListMuteRules.java) |
| Set Mute Unmute Finding | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetMuteUnmuteFinding.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetMuteUnmuteFinding.java) |
| Set Mute Finding | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetMuteFinding.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetMuteFinding.java) |
| Set Unmute Finding | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetUnmuteFinding.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/SetUnmuteFinding.java) |
| Update Mute Rule | [source code](https://github.com/googleapis/java-securitycenter/blob/main/samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/UpdateMuteRule.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-securitycenter&page=editor&open_in_editor=samples/snippets/src/main/java/com/google/cloud/examples/securitycenter/snippets/muteconfig/UpdateMuteRule.java) |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@

package com.google.cloud.examples.securitycenter.snippets.muteconfig;

// [START securitycenter_set_mute_unmute]
// [START securitycenter_set_mute]

import com.google.cloud.securitycenter.v1.Finding;
import com.google.cloud.securitycenter.v1.Finding.Mute;
import com.google.cloud.securitycenter.v1.SecurityCenterClient;
import com.google.cloud.securitycenter.v1.SetMuteRequest;
import java.io.IOException;

public class SetMuteUnmuteFinding {
public class SetMuteFinding {

public static void main(String[] args) {
// TODO: Replace the variables within {}
Expand All @@ -39,9 +39,8 @@ public static void main(String[] args) {
setMute(findingPath);
}

// Mute/unmute an individual finding.
// Mute an individual finding.
// If a finding is already muted, muting it again has no effect.
// Similarly, unmuting a finding that isn't muted has no effect.
// Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
public static void setMute(String findingPath) {
// Initialize client that will be used to send requests. This client only needs to be created
Expand All @@ -53,10 +52,11 @@ public static void setMute(String findingPath) {
SetMuteRequest.newBuilder().setName(findingPath).setMute(Mute.MUTED).build();

Finding finding = client.setMute(setMuteRequest);
System.out.println("Mute value for the finding: " + finding.getMute());
System.out.println(
"Mute value for the finding " + finding.getName() + " is: " + finding.getMute());
} catch (IOException e) {
System.out.println("Failed to set the specified mute value. \n Exception: " + e);
}
}
}
// [END securitycenter_set_mute_unmute]
// [END securitycenter_set_mute]
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.cloud.examples.securitycenter.snippets.muteconfig;

// [START securitycenter_set_unmute]

import com.google.cloud.securitycenter.v1.Finding;
import com.google.cloud.securitycenter.v1.Finding.Mute;
import com.google.cloud.securitycenter.v1.SecurityCenterClient;
import com.google.cloud.securitycenter.v1.SetMuteRequest;
import java.io.IOException;

public class SetUnmuteFinding {

public static void main(String[] args) {
// TODO: Replace the variables within {}

// findingPath: The relative resource name of the finding. See:
// https://cloud.google.com/apis/design/resource_names#relative_resource_name
// Use any one of the following formats:
// - organizations/{organization_id}/sources/{source_id}/finding/{finding_id}
// - folders/{folder_id}/sources/{source_id}/finding/{finding_id}
// - projects/{project_id}/sources/{source_id}/finding/{finding_id}
String findingPath = "{path-to-the-finding}";
setUnmute(findingPath);
}

// Unmute an individual finding.
// Unmuting a finding that isn't muted has no effect.
// Various mute states are: MUTE_UNSPECIFIED/MUTE/UNMUTE.
public static void setUnmute(String findingPath) {
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the "close" method on the client to safely clean up any remaining background resources.
try (SecurityCenterClient client = SecurityCenterClient.create()) {

SetMuteRequest setMuteRequest =
SetMuteRequest.newBuilder().setName(findingPath).setMute(Mute.UNMUTED).build();
Shabirmean marked this conversation as resolved.
Show resolved Hide resolved

Finding finding = client.setMute(setMuteRequest);
System.out.println(
"Mute value for the finding " + finding.getName() + " is: " + finding.getMute());
} catch (IOException e) {
System.out.println("Failed to set the specified mute value. \n Exception: " + e);
}
}
}
// [END securitycenter_set_unmute]
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
import com.google.cloud.examples.securitycenter.snippets.muteconfig.DeleteMuteRule;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.GetMuteRule;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.ListMuteRules;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.SetMuteUnmuteFinding;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.SetMuteFinding;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.SetUnmuteFinding;
import com.google.cloud.examples.securitycenter.snippets.muteconfig.UpdateMuteRule;
import com.google.cloud.securitycenter.v1.CreateSourceRequest;
import com.google.cloud.securitycenter.v1.Finding;
Expand Down Expand Up @@ -215,8 +216,12 @@ public void testUpdateMuteRules() {

@Test
public void testSetMuteFinding() {
SetMuteUnmuteFinding.setMute(FINDING_1.getName());
assertThat(stdOut.toString()).contains("Mute value for the finding: MUTED");
SetMuteFinding.setMute(FINDING_1.getName());
assertThat(stdOut.toString()).contains(
"Mute value for the finding " + FINDING_1.getName() + " is: " + "MUTED");
SetUnmuteFinding.setUnmute(FINDING_1.getName());
assertThat(stdOut.toString()).contains(
"Mute value for the finding " + FINDING_1.getName() + " is: " + "UNMUTED");
}

@Test
Expand Down