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

Commit

Permalink
feat: add GetMetrics and MigrateKey methods to reCAPTCHA enterprise A…
Browse files Browse the repository at this point in the history 
…PI (#574)

* feat: add GetMetrics and MigrateKey methods to reCAPTCHA enterprise API

PiperOrigin-RevId: 396937887

Source-Link: googleapis/googleapis@020672e

Source-Link: googleapis/googleapis-gen@a584790
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTU4NDc5MDdlYjM2MDc4MzdmMTBmOTNlOTVmZGZjYzBhOThlNmYyMSJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Sep 16, 2021
1 parent 343c9c6 commit aba39fa
Show file tree
Hide file tree
Showing 40 changed files with 10,569 additions and 228 deletions.
171 changes: 165 additions & 6 deletions ...c/main/java/com/google/cloud/recaptchaenterprise/v1/RecaptchaEnterpriseServiceClient.java
View file
Expand Up @@ -37,9 +37,13 @@
import com.google.recaptchaenterprise.v1.CreateKeyRequest;
import com.google.recaptchaenterprise.v1.DeleteKeyRequest;
import com.google.recaptchaenterprise.v1.GetKeyRequest;
import com.google.recaptchaenterprise.v1.GetMetricsRequest;
import com.google.recaptchaenterprise.v1.Key;
import com.google.recaptchaenterprise.v1.ListKeysRequest;
import com.google.recaptchaenterprise.v1.ListKeysResponse;
import com.google.recaptchaenterprise.v1.Metrics;
import com.google.recaptchaenterprise.v1.MetricsName;
import com.google.recaptchaenterprise.v1.MigrateKeyRequest;
import com.google.recaptchaenterprise.v1.ProjectName;
import com.google.recaptchaenterprise.v1.UpdateKeyRequest;
import java.io.IOException;
Expand Down Expand Up @@ -275,7 +279,7 @@ public final UnaryCallable<CreateAssessmentRequest, Assessment> createAssessment
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Annotates a previously created Assessment to provide additional information on whether the
* event turned out to be authentic or fradulent.
* event turned out to be authentic or fraudulent.
*
* <p>Sample code:
*
Expand All @@ -292,7 +296,9 @@ public final UnaryCallable<CreateAssessmentRequest, Assessment> createAssessment
*
* @param name Required. The resource name of the Assessment, in the format
* "projects/{project}/assessments/{assessment}".
* @param annotation Required. The annotation that will be assigned to the Event.
* @param annotation Optional. The annotation that will be assigned to the Event. This field can
* be left empty to provide reasons that apply to an event without concluding whether the
* event is legitimate or fraudulent.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotateAssessmentResponse annotateAssessment(
Expand All @@ -308,7 +314,7 @@ public final AnnotateAssessmentResponse annotateAssessment(
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Annotates a previously created Assessment to provide additional information on whether the
* event turned out to be authentic or fradulent.
* event turned out to be authentic or fraudulent.
*
* <p>Sample code:
*
Expand All @@ -325,7 +331,9 @@ public final AnnotateAssessmentResponse annotateAssessment(
*
* @param name Required. The resource name of the Assessment, in the format
* "projects/{project}/assessments/{assessment}".
* @param annotation Required. The annotation that will be assigned to the Event.
* @param annotation Optional. The annotation that will be assigned to the Event. This field can
* be left empty to provide reasons that apply to an event without concluding whether the
* event is legitimate or fraudulent.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotateAssessmentResponse annotateAssessment(
Expand All @@ -338,7 +346,7 @@ public final AnnotateAssessmentResponse annotateAssessment(
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Annotates a previously created Assessment to provide additional information on whether the
* event turned out to be authentic or fradulent.
* event turned out to be authentic or fraudulent.
*
* <p>Sample code:
*
Expand All @@ -348,6 +356,7 @@ public final AnnotateAssessmentResponse annotateAssessment(
* AnnotateAssessmentRequest request =
* AnnotateAssessmentRequest.newBuilder()
* .setName(AssessmentName.of("[PROJECT]", "[ASSESSMENT]").toString())
* .addAllReasons(new ArrayList<AnnotateAssessmentRequest.Reason>())
* .build();
* AnnotateAssessmentResponse response =
* recaptchaEnterpriseServiceClient.annotateAssessment(request);
Expand All @@ -364,7 +373,7 @@ public final AnnotateAssessmentResponse annotateAssessment(AnnotateAssessmentReq
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Annotates a previously created Assessment to provide additional information on whether the
* event turned out to be authentic or fradulent.
* event turned out to be authentic or fraudulent.
*
* <p>Sample code:
*
Expand All @@ -374,6 +383,7 @@ public final AnnotateAssessmentResponse annotateAssessment(AnnotateAssessmentReq
* AnnotateAssessmentRequest request =
* AnnotateAssessmentRequest.newBuilder()
* .setName(AssessmentName.of("[PROJECT]", "[ASSESSMENT]").toString())
* .addAllReasons(new ArrayList<AnnotateAssessmentRequest.Reason>())
* .build();
* ApiFuture<AnnotateAssessmentResponse> future =
* recaptchaEnterpriseServiceClient.annotateAssessmentCallable().futureCall(request);
Expand Down Expand Up @@ -669,6 +679,155 @@ public final UnaryCallable<DeleteKeyRequest, Empty> deleteKeyCallable() {
return stub.deleteKeyCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can
* be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must
* be authenticated as one of the current owners of the reCAPTCHA Site Key, and your user must
* have the reCAPTCHA Enterprise Admin IAM role in the destination project.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* MigrateKeyRequest request =
* MigrateKeyRequest.newBuilder()
* .setName(KeyName.of("[PROJECT]", "[KEY]").toString())
* .build();
* Key response = recaptchaEnterpriseServiceClient.migrateKey(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Key migrateKey(MigrateKeyRequest request) {
return migrateKeyCallable().call(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can
* be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must
* be authenticated as one of the current owners of the reCAPTCHA Site Key, and your user must
* have the reCAPTCHA Enterprise Admin IAM role in the destination project.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* MigrateKeyRequest request =
* MigrateKeyRequest.newBuilder()
* .setName(KeyName.of("[PROJECT]", "[KEY]").toString())
* .build();
* ApiFuture<Key> future =
* recaptchaEnterpriseServiceClient.migrateKeyCallable().futureCall(request);
* // Do something.
* Key response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<MigrateKeyRequest, Key> migrateKeyCallable() {
return stub.migrateKeyCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get some aggregated metrics for a Key. This data can be used to build dashboards.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* MetricsName name = MetricsName.of("[PROJECT]", "[KEY]");
* Metrics response = recaptchaEnterpriseServiceClient.getMetrics(name);
* }
* }</pre>
*
* @param name Required. The name of the requested metrics, in the format
* "projects/{project}/keys/{key}/metrics".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Metrics getMetrics(MetricsName name) {
GetMetricsRequest request =
GetMetricsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getMetrics(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get some aggregated metrics for a Key. This data can be used to build dashboards.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* String name = MetricsName.of("[PROJECT]", "[KEY]").toString();
* Metrics response = recaptchaEnterpriseServiceClient.getMetrics(name);
* }
* }</pre>
*
* @param name Required. The name of the requested metrics, in the format
* "projects/{project}/keys/{key}/metrics".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Metrics getMetrics(String name) {
GetMetricsRequest request = GetMetricsRequest.newBuilder().setName(name).build();
return getMetrics(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get some aggregated metrics for a Key. This data can be used to build dashboards.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* GetMetricsRequest request =
* GetMetricsRequest.newBuilder()
* .setName(MetricsName.of("[PROJECT]", "[KEY]").toString())
* .build();
* Metrics response = recaptchaEnterpriseServiceClient.getMetrics(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Metrics getMetrics(GetMetricsRequest request) {
return getMetricsCallable().call(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get some aggregated metrics for a Key. This data can be used to build dashboards.
*
* <p>Sample code:
*
* <pre>{@code
* try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
* RecaptchaEnterpriseServiceClient.create()) {
* GetMetricsRequest request =
* GetMetricsRequest.newBuilder()
* .setName(MetricsName.of("[PROJECT]", "[KEY]").toString())
* .build();
* ApiFuture<Metrics> future =
* recaptchaEnterpriseServiceClient.getMetricsCallable().futureCall(request);
* // Do something.
* Metrics response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetMetricsRequest, Metrics> getMetricsCallable() {
return stub.getMetricsCallable();
}

@Override
public final void close() {
stub.close();
Expand Down
23 changes: 23 additions & 0 deletions ...main/java/com/google/cloud/recaptchaenterprise/v1/RecaptchaEnterpriseServiceSettings.java
View file
Expand Up @@ -38,9 +38,12 @@
import com.google.recaptchaenterprise.v1.CreateKeyRequest;
import com.google.recaptchaenterprise.v1.DeleteKeyRequest;
import com.google.recaptchaenterprise.v1.GetKeyRequest;
import com.google.recaptchaenterprise.v1.GetMetricsRequest;
import com.google.recaptchaenterprise.v1.Key;
import com.google.recaptchaenterprise.v1.ListKeysRequest;
import com.google.recaptchaenterprise.v1.ListKeysResponse;
import com.google.recaptchaenterprise.v1.Metrics;
import com.google.recaptchaenterprise.v1.MigrateKeyRequest;
import com.google.recaptchaenterprise.v1.UpdateKeyRequest;
import java.io.IOException;
import java.util.List;
Expand Down Expand Up @@ -122,6 +125,16 @@ public UnaryCallSettings<DeleteKeyRequest, Empty> deleteKeySettings() {
return ((RecaptchaEnterpriseServiceStubSettings) getStubSettings()).deleteKeySettings();
}

/** Returns the object with the settings used for calls to migrateKey. */
public UnaryCallSettings<MigrateKeyRequest, Key> migrateKeySettings() {
return ((RecaptchaEnterpriseServiceStubSettings) getStubSettings()).migrateKeySettings();
}

/** Returns the object with the settings used for calls to getMetrics. */
public UnaryCallSettings<GetMetricsRequest, Metrics> getMetricsSettings() {
return ((RecaptchaEnterpriseServiceStubSettings) getStubSettings()).getMetricsSettings();
}

public static final RecaptchaEnterpriseServiceSettings create(
RecaptchaEnterpriseServiceStubSettings stub) throws IOException {
return new RecaptchaEnterpriseServiceSettings.Builder(stub.toBuilder()).build();
Expand Down Expand Up @@ -258,6 +271,16 @@ public UnaryCallSettings.Builder<DeleteKeyRequest, Empty> deleteKeySettings() {
return getStubSettingsBuilder().deleteKeySettings();
}

/** Returns the builder for the settings used for calls to migrateKey. */
public UnaryCallSettings.Builder<MigrateKeyRequest, Key> migrateKeySettings() {
return getStubSettingsBuilder().migrateKeySettings();
}

/** Returns the builder for the settings used for calls to getMetrics. */
public UnaryCallSettings.Builder<GetMetricsRequest, Metrics> getMetricsSettings() {
return getStubSettingsBuilder().getMetricsSettings();
}

@Override
public RecaptchaEnterpriseServiceSettings build() throws IOException {
return new RecaptchaEnterpriseServiceSettings(this);
Expand Down
6 changes: 6 additions & 0 deletions ...ptchaenterprise/src/main/java/com/google/cloud/recaptchaenterprise/v1/gapic_metadata.json
View file
Expand Up @@ -25,9 +25,15 @@
"GetKey": {
"methods": ["getKey", "getKeyCallable"]
},
"GetMetrics": {
"methods": ["getMetrics", "getMetrics", "getMetrics", "getMetricsCallable"]
},
"ListKeys": {
"methods": ["listKeys", "listKeysPagedCallable", "listKeysCallable"]
},
"MigrateKey": {
"methods": ["migrateKey", "migrateKeyCallable"]
},
"UpdateKey": {
"methods": ["updateKey", "updateKeyCallable"]
}
Expand Down

0 comments on commit aba39fa

Please sign in to comment.