aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGoogle APIs <noreply@google.com>2019-04-03 08:17:37 -0700
committerCopybara-Service <copybara-worker@google.com>2019-04-03 08:18:07 -0700
commita2c49e2bc36158973ea802711cd942f7bc30c4ee (patch)
tree6498cdd929b15eb1080d2427c9d3af5439e65a12
parent8dab717b2851750c829530669fe5cebafef22fb8 (diff)
downloadgoogleapis-a2c49e2bc36158973ea802711cd942f7bc30c4ee.tar.gz
Synchronize new proto/yaml changes.
PiperOrigin-RevId: 241734214
-rw-r--r--google/cloud/recaptchaenterprise/artman_recaptchaenterprise_v1beta1.yaml34
-rw-r--r--google/cloud/recaptchaenterprise/recaptchaenterprise_v1beta1.yaml18
-rw-r--r--google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto182
-rw-r--r--google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_gapic.yaml147
4 files changed, 381 insertions, 0 deletions
diff --git a/google/cloud/recaptchaenterprise/artman_recaptchaenterprise_v1beta1.yaml b/google/cloud/recaptchaenterprise/artman_recaptchaenterprise_v1beta1.yaml
new file mode 100644
index 000000000..9303e71b4
--- /dev/null
+++ b/google/cloud/recaptchaenterprise/artman_recaptchaenterprise_v1beta1.yaml
@@ -0,0 +1,34 @@
+common:
+ api_name: recaptchaenterprise
+ api_version: v1beta1
+ organization_name: google-cloud
+ proto_deps:
+ - name: google-common-protos
+ src_proto_paths:
+ - v1beta1
+ service_yaml: recaptchaenterprise_v1beta1.yaml
+ gapic_yaml: v1beta1/recaptchaenterprise_gapic.yaml
+artifacts:
+- name: gapic_config
+ type: GAPIC_CONFIG
+- name: java_gapic
+ type: GAPIC
+ language: JAVA
+- name: python_gapic
+ type: GAPIC
+ language: PYTHON
+- name: nodejs_gapic
+ type: GAPIC
+ language: NODEJS
+- name: php_gapic
+ type: GAPIC
+ language: PHP
+- name: go_gapic
+ type: GAPIC
+ language: GO
+- name: ruby_gapic
+ type: GAPIC
+ language: RUBY
+- name: csharp_gapic
+ type: GAPIC
+ language: CSHARP
diff --git a/google/cloud/recaptchaenterprise/recaptchaenterprise_v1beta1.yaml b/google/cloud/recaptchaenterprise/recaptchaenterprise_v1beta1.yaml
new file mode 100644
index 000000000..4996c5a4f
--- /dev/null
+++ b/google/cloud/recaptchaenterprise/recaptchaenterprise_v1beta1.yaml
@@ -0,0 +1,18 @@
+type: google.api.Service
+config_version: 3
+name: recaptchaenterprise.googleapis.com
+title: reCAPTCHA Enterprise API
+
+apis:
+- name: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1
+
+authentication:
+ rules:
+ - selector: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.AnnotateAssessment
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
+ - selector: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.CreateAssessment
+ oauth:
+ canonical_scopes: |-
+ https://www.googleapis.com/auth/cloud-platform
diff --git a/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto
new file mode 100644
index 000000000..8a378bce8
--- /dev/null
+++ b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto
@@ -0,0 +1,182 @@
+// Copyright 2019 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.
+//
+
+syntax = "proto3";
+
+package google.cloud.recaptchaenterprise.v1beta1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.RecaptchaEnterprise.V1Beta1";
+option go_package = "google.golang.org/genproto/googleapis/cloud/recaptchaenterprise/v1beta1;recaptchaenterprise";
+option java_multiple_files = true;
+option java_outer_classname = "RecaptchaEnterpriseProto";
+option java_package = "com.google.recaptchaenterprise.v1beta1";
+option objc_class_prefix = "GCRE";
+option php_namespace = "Google\\Cloud\\RecaptchaEnterprise\\V1beta1";
+
+
+// Service to determine the likelihood an event is legitimate.
+service RecaptchaEnterpriseServiceV1Beta1 {
+ // Creates an Assessment of the likelihood an event is legitimate.
+ rpc CreateAssessment(CreateAssessmentRequest) returns (Assessment) {
+ option (google.api.http) = {
+ post: "/v1beta1/{parent=projects/*}/assessments"
+ body: "assessment"
+ };
+ }
+
+ // Annotates a previously created Assessment to provide additional information
+ // on whether the event turned out to be authentic or fradulent.
+ rpc AnnotateAssessment(AnnotateAssessmentRequest) returns (AnnotateAssessmentResponse) {
+ option (google.api.http) = {
+ post: "/v1beta1/{name=projects/*/assessments/*}:annotate"
+ body: "*"
+ };
+ }
+}
+
+// The create assessment request message.
+message CreateAssessmentRequest {
+ // Required. The name of the project in which the assessment will be created,
+ // in the format "projects/{project_number}".
+ string parent = 1;
+
+ // The asessment details.
+ Assessment assessment = 2;
+}
+
+// The request message to annotate an Assessment.
+message AnnotateAssessmentRequest {
+ // Enum that reprensents the types of annotations.
+ enum Annotation {
+ // Default unspecified type.
+ ANNOTATION_UNSPECIFIED = 0;
+
+ // Provides information that the event turned out to be legitimate.
+ LEGITIMATE = 1;
+
+ // Provides information that the event turned out to be fraudulent.
+ FRAUDULENT = 2;
+ }
+
+ // Required. The resource name of the Assessment, in the format
+ // "projects/{project_number}/assessments/{assessment_id}".
+ string name = 1;
+
+ // The annotation that will be assigned to the Event.
+ Annotation annotation = 2;
+}
+
+// Empty response for AnnotateAssessment.
+message AnnotateAssessmentResponse {
+
+}
+
+// A recaptcha assessment resource.
+message Assessment {
+ // LINT.IfChange(classification_reason)
+ // Reasons contributing to the risk analysis verdict.
+ enum ClassificationReason {
+ // Default unspecified type.
+ CLASSIFICATION_REASON_UNSPECIFIED = 0;
+
+ // The event appeared to be automated.
+ AUTOMATION = 1;
+
+ // The event was not made from the proper context on the real site.
+ UNEXPECTED_ENVIRONMENT = 2;
+
+ // Browsing behavior leading up to the event was generated was out of the
+ // ordinary.
+ UNEXPECTED_USAGE_PATTERNS = 4;
+
+ // Too little traffic has been received from this site thus far to generate
+ // quality risk analysis.
+ PROVISIONAL_RISK_ANALYSIS = 5;
+ }
+
+ // Output only. The resource name for the Assessment in the format
+ // "projects/{project_number}/assessments/{assessment_id}".
+ string name = 1;
+
+ // The event being assessed.
+ Event event = 2;
+
+ // Output only. Legitimate event confidence estimate from 0.0 to 1.0
+ // (1.0 means legitimate).
+ float confidence = 3;
+
+ // Output only. Properties of the provided event token.
+ TokenProperties token_properties = 4;
+
+ // Output only. Reasons contributing to the risk analysis verdict.
+ repeated ClassificationReason reasons = 5;
+}
+
+message Event {
+ // The user response token provided by the reCAPTCHA client-side integration
+ // on your site.
+ string token = 1;
+
+ // The site key that was used to invoke reCAPTCHA on your site and generate
+ // the token.
+ string site_key = 2;
+}
+
+message TokenProperties {
+ // Enum that represents the types of invalid token reasons.
+ enum InvalidReason {
+ // Default unspecified type.
+ INVALID_REASON_UNSPECIFIED = 0;
+
+ // If the failure reason was not accounted for.
+ UNKNOWN_INVALID_REASON = 1;
+
+ // The provided user verification token was malformed.
+ MALFORMED = 2;
+
+ // The user verification token had expired.
+ EXPIRED = 3;
+
+ // The user verification had already been seen.
+ DUPE = 4;
+
+ // The user verification token did not match the provided site secret.
+ // This may be a configuration error (e.g. development keys used in
+ // production) or end users trying to use verification tokens from other
+ // sites.
+ SITE_MISMATCH = 5;
+
+ // The user verification token was not present. It is a required input.
+ MISSING = 6;
+ }
+
+ // Output only. Whether the provided user response token is valid.
+ bool valid = 1;
+
+ // Output only. Reason associated with the response when valid = false.
+ InvalidReason invalid_reason = 2;
+
+ // Output only. The timestamp corresponding to the generation of the token.
+ google.protobuf.Timestamp create_time = 3;
+
+ // Output only. The hostname of the page on which the token was generated.
+ string hostname = 4;
+
+ // Output only. Action name provided at token generation.
+ string action = 5;
+}
diff --git a/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_gapic.yaml b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_gapic.yaml
new file mode 100644
index 000000000..9b4270347
--- /dev/null
+++ b/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_gapic.yaml
@@ -0,0 +1,147 @@
+type: com.google.api.codegen.ConfigProto
+config_schema_version: 1.0.0
+# The settings of generated code in a specific language.
+language_settings:
+ java:
+ package_name: com.google.cloud.recaptchaenterprise.v1beta1
+ python:
+ package_name: google.cloud.recaptchaenterprise_v1beta1.gapic
+ go:
+ package_name: cloud.google.com/go/recaptchaenterprise/apiv1beta1
+ csharp:
+ package_name: Google.Cloud.RecaptchaEnterprise.V1Beta1
+ ruby:
+ package_name: Google::Cloud::RecaptchaEnterprise::V1beta1
+ php:
+ package_name: Google\Cloud\RecaptchaEnterprise\V1beta1
+ nodejs:
+ package_name: recaptchaenterprise.v1beta1
+# The configuration for the license header to put on generated files.
+license_header:
+ # The file containing the copyright line(s).
+ copyright_file: copyright-google.txt
+ # The file containing the raw license header without any copyright line(s).
+ license_file: license-header-apache-2.0.txt
+# A list of API interface configurations.
+interfaces:
+# The fully qualified name of the API interface.
+- name: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1
+ # A list of resource collection configurations.
+ # Consists of a name_pattern and an entity_name.
+ # The name_pattern is a pattern to describe the names of the resources of this
+ # collection, using the platform's conventions for URI patterns. A generator
+ # may use this to generate methods to compose and decompose such names. The
+ # pattern should use named placeholders as in `shelves/{shelf}/books/{book}`;
+ # those will be taken as hints for the parameter names of the generated
+ # methods. If empty, no name methods are generated.
+ # The entity_name is the name to be used as a basis for generated methods and
+ # classes.
+ collections:
+ - name_pattern: projects/{project}
+ entity_name: project
+ language_overrides:
+ - language: csharp
+ common_resource_name: Google.Api.Gax.ResourceNames.ProjectName
+ - name_pattern: projects/{project}/assessments/{assessment}
+ entity_name: assessment
+ # Definition for retryable codes.
+ retry_codes_def:
+ - name: idempotent
+ retry_codes:
+ - DEADLINE_EXCEEDED
+ - UNAVAILABLE
+ - name: non_idempotent
+ retry_codes: []
+ # Definition for retry/backoff parameters.
+ retry_params_def:
+ - name: default
+ initial_retry_delay_millis: 100
+ retry_delay_multiplier: 1.3
+ max_retry_delay_millis: 60000
+ initial_rpc_timeout_millis: 20000
+ rpc_timeout_multiplier: 1
+ max_rpc_timeout_millis: 20000
+ total_timeout_millis: 600000
+ # A list of method configurations.
+ # Common properties:
+ #
+ # name - The simple name of the method.
+ #
+ # flattening - Specifies the configuration for parameter flattening.
+ # Describes the parameter groups for which a generator should produce method
+ # overloads which allow a client to directly pass request message fields as
+ # method parameters. This information may or may not be used, depending on
+ # the target language.
+ # Consists of groups, which each represent a list of parameters to be
+ # flattened. Each parameter listed must be a field of the request message.
+ #
+ # required_fields - Fields that are always required for a request to be
+ # valid.
+ #
+ # resource_name_treatment - An enum that specifies how to treat the resource
+ # name formats defined in the field_name_patterns and
+ # response_field_name_patterns fields.
+ # UNSET: default value
+ # NONE: the collection configs will not be used by the generated code.
+ # VALIDATE: string fields will be validated by the client against the
+ # specified resource name formats.
+ # STATIC_TYPES: the client will use generated types for resource names.
+ #
+ # page_streaming - Specifies the configuration for paging.
+ # Describes information for generating a method which transforms a paging
+ # list RPC into a stream of resources.
+ # Consists of a request and a response.
+ # The request specifies request information of the list method. It defines
+ # which fields match the paging pattern in the request. The request consists
+ # of a page_size_field and a token_field. The page_size_field is the name of
+ # the optional field specifying the maximum number of elements to be
+ # returned in the response. The token_field is the name of the field in the
+ # request containing the page token.
+ # The response specifies response information of the list method. It defines
+ # which fields match the paging pattern in the response. The response
+ # consists of a token_field and a resources_field. The token_field is the
+ # name of the field in the response containing the next page token. The
+ # resources_field is the name of the field in the response containing the
+ # list of resources belonging to the page.
+ #
+ # retry_codes_name - Specifies the configuration for retryable codes. The
+ # name must be defined in interfaces.retry_codes_def.
+ #
+ # retry_params_name - Specifies the configuration for retry/backoff
+ # parameters. The name must be defined in interfaces.retry_params_def.
+ #
+ # field_name_patterns - Maps the field name of the request type to
+ # entity_name of interfaces.collections.
+ # Specifies the string pattern that the field must follow.
+ #
+ # timeout_millis - Specifies the default timeout for a non-retrying call. If
+ # the call is retrying, refer to retry_params_name instead.
+ methods:
+ - name: CreateAssessment
+ flattening:
+ groups:
+ - parameters:
+ - parent
+ - assessment
+ required_fields:
+ - parent
+ - assessment
+ retry_codes_name: non_idempotent
+ retry_params_name: default
+ field_name_patterns:
+ parent: project
+ timeout_millis: 60000
+ - name: AnnotateAssessment
+ flattening:
+ groups:
+ - parameters:
+ - name
+ - annotation
+ required_fields:
+ - name
+ - annotation
+ retry_codes_name: non_idempotent
+ retry_params_name: default
+ field_name_patterns:
+ name: assessment
+ timeout_millis: 60000