This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(samples): added samples and test for recaptcha key operations (#643
) * docs(samples): added samples and test for recaptcha key operations * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs(samples): modified return type of ListSiteKey to be re-used in Migrate Key sample * docs(samples): added comment Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
728981a
commit 748d165
Showing
5 changed files
with
157 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
samples/snippets/cloud-client/src/main/java/recaptcha/GetMetrics.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright 2021 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 recaptcha; | ||
|
|
||
| // [START recaptcha_enterprise_get_metrics_site_key] | ||
|
|
||
| import com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceClient; | ||
| import com.google.recaptchaenterprise.v1.GetMetricsRequest; | ||
| import com.google.recaptchaenterprise.v1.Metrics; | ||
| import com.google.recaptchaenterprise.v1.MetricsName; | ||
| import com.google.recaptchaenterprise.v1.ScoreMetrics; | ||
| import java.io.IOException; | ||
|
|
||
| public class GetMetrics { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| String projectId = "project-id"; | ||
| String recaptchaSiteKey = "recaptcha-site-key"; | ||
|
|
||
| getMetrics(projectId, recaptchaSiteKey); | ||
| } | ||
|
|
||
| /** | ||
| * Get metrics specific to a recaptcha site key. E.g: score bucket count for a key or number of | ||
| * times the checkbox key failed/ passed etc., | ||
| * | ||
| * @param projectId: Google Cloud Project Id. | ||
| * @param recaptchaSiteKey: Specify the site key to get metrics. | ||
| */ | ||
| public static void getMetrics(String projectId, String recaptchaSiteKey) throws IOException { | ||
| // 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 `client.close()` method on the client to safely | ||
| // clean up any remaining background resources. | ||
| try (RecaptchaEnterpriseServiceClient client = RecaptchaEnterpriseServiceClient.create()) { | ||
|
|
||
| GetMetricsRequest getMetricsRequest = | ||
| GetMetricsRequest.newBuilder() | ||
| .setName(MetricsName.of(projectId, recaptchaSiteKey).toString()) | ||
| .build(); | ||
|
|
||
| Metrics response = client.getMetrics(getMetricsRequest); | ||
|
|
||
| // Retrieve the metrics you want from the key. | ||
| // If the site key is checkbox type: then use response.getChallengeMetricsList() instead of | ||
| // response.getScoreMetricsList() | ||
| for (ScoreMetrics scoreMetrics : response.getScoreMetricsList()) { | ||
| // Each ScoreMetrics is in the granularity of one day. | ||
| int scoreBucketCount = scoreMetrics.getOverallMetrics().getScoreBucketsCount(); | ||
| System.out.println(scoreBucketCount); | ||
| } | ||
| System.out.printf("Retrieved the bucket count for score based key: %s", recaptchaSiteKey); | ||
| } | ||
| } | ||
| } | ||
| // [END recaptcha_enterprise_get_metrics_site_key] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
samples/snippets/cloud-client/src/main/java/recaptcha/MigrateKey.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* | ||
| * Copyright 2021 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 recaptcha; | ||
|
|
||
| // [START recaptcha_enterprise_migrate_site_key] | ||
|
|
||
| import com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceClient; | ||
| import com.google.recaptchaenterprise.v1.Key; | ||
| import com.google.recaptchaenterprise.v1.KeyName; | ||
| import com.google.recaptchaenterprise.v1.MigrateKeyRequest; | ||
| import java.io.IOException; | ||
|
|
||
| public class MigrateKey { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| String projectId = "project-id"; | ||
| String recaptchaSiteKey = "recaptcha-site-key"; | ||
|
|
||
| migrateKey(projectId, recaptchaSiteKey); | ||
| } | ||
|
|
||
| /** | ||
| * Migrate a key from reCAPTCHA (non-Enterprise) to reCAPTCHA Enterprise. If you created the key | ||
| * using Admin console: https://www.google.com/recaptcha/admin/site, then use this API to migrate | ||
| * to reCAPTCHA Enterprise. For more info, see: | ||
| * https://cloud.google.com/recaptcha-enterprise/docs/migrate-recaptcha | ||
| * | ||
| * @param projectId: Google Cloud Project Id. | ||
| * @param recaptchaSiteKey: Specify the site key to migrate. | ||
| */ | ||
| public static void migrateKey(String projectId, String recaptchaSiteKey) throws IOException { | ||
| // 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 `client.close()` method on the client to safely | ||
| // clean up any remaining background resources. | ||
| try (RecaptchaEnterpriseServiceClient client = RecaptchaEnterpriseServiceClient.create()) { | ||
|
|
||
| // Specify the key name to migrate. | ||
| MigrateKeyRequest migrateKeyRequest = | ||
| MigrateKeyRequest.newBuilder() | ||
| .setName(KeyName.of(projectId, recaptchaSiteKey).toString()) | ||
| .build(); | ||
|
|
||
| Key response = client.migrateKey(migrateKeyRequest); | ||
|
|
||
| // To verify if the site key has been migrated, use 'ListSiteKeys' and check if the | ||
| // key is present. | ||
| for (Key key : recaptcha.ListSiteKeys.listSiteKeys(projectId).iterateAll()) { | ||
| if (key.equals(response)) { | ||
| System.out.printf("Key migrated successfully: %s", recaptchaSiteKey); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // [END recaptcha_enterprise_migrate_site_key] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters