google-cloud-recaptcha_enterprise-v1 0.11.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb +40 -32
- data/lib/google/cloud/recaptcha_enterprise/v1/version.rb +1 -1
- data/lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_pb.rb +33 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb +160 -54
- data/proto_docs/google/protobuf/duration.rb +98 -0
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9cb553d077ccc71cb034e2fb0ff624aabf5fb6298c0ebcccd700b3df74a537f3
|
4
|
+
data.tar.gz: c8fda32169b5a4a491bcfff8f3fa23f0a349d2fe13962466148491eb724ad220
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 68c5f54671922f909bdf340b4446abee0c48270cc06d85ae0245a6998e5317221364f3254bca80365080160ea51f19e4504fcc6f39539ab109d89c2a388db3e2
|
7
|
+
data.tar.gz: 5245bcdff7ab73ca97db012172bcd0b77f8abcc4d4d29dabec8f752fb2e1c692ad6d89edbd90e22d16c95ae720b15dee28b425cbc8bd273569a4a3b59f04bf12
|
data/README.md
CHANGED
@@ -46,7 +46,7 @@ for general usage information.
|
|
46
46
|
## Enabling Logging
|
47
47
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
49
|
-
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/
|
49
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
50
50
|
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
51
51
|
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
@@ -269,11 +269,12 @@ module Google
|
|
269
269
|
# Required. The resource name of the Assessment, in the format
|
270
270
|
# "projects/\\{project}/assessments/\\{assessment}".
|
271
271
|
# @param annotation [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
|
272
|
-
# Optional. The annotation that will be assigned to the Event. This field can
|
273
|
-
# empty to provide reasons that apply to an event without concluding
|
274
|
-
# the event is legitimate or fraudulent.
|
272
|
+
# Optional. The annotation that will be assigned to the Event. This field can
|
273
|
+
# be left empty to provide reasons that apply to an event without concluding
|
274
|
+
# whether the event is legitimate or fraudulent.
|
275
275
|
# @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
|
276
|
-
# Optional. Optional reasons for the annotation that will be assigned to the
|
276
|
+
# Optional. Optional reasons for the annotation that will be assigned to the
|
277
|
+
# Event.
|
277
278
|
# @param hashed_account_id [::String]
|
278
279
|
# Optional. Unique stable hashed user identifier to apply to the assessment.
|
279
280
|
# This is an alternative to setting the hashed_account_id in
|
@@ -553,8 +554,8 @@ module Google
|
|
553
554
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
554
555
|
#
|
555
556
|
# @param key [::String]
|
556
|
-
# Required. The public key name linked to the requested secret key in the
|
557
|
-
# "projects/\\{project}/keys/\\{key}".
|
557
|
+
# Required. The public key name linked to the requested secret key in the
|
558
|
+
# format "projects/\\{project}/keys/\\{key}".
|
558
559
|
#
|
559
560
|
# @yield [response, operation] Access the result along with the RPC operation
|
560
561
|
# @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse]
|
@@ -727,8 +728,8 @@ module Google
|
|
727
728
|
# @param key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash]
|
728
729
|
# Required. The key to update.
|
729
730
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
730
|
-
# Optional. The mask to control which fields of the key get updated. If the
|
731
|
-
# present, all fields will be updated.
|
731
|
+
# Optional. The mask to control which fields of the key get updated. If the
|
732
|
+
# mask is not present, all fields will be updated.
|
732
733
|
#
|
733
734
|
# @yield [response, operation] Access the result along with the RPC operation
|
734
735
|
# @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key]
|
@@ -898,7 +899,7 @@ module Google
|
|
898
899
|
# @param options [::Gapic::CallOptions, ::Hash]
|
899
900
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
900
901
|
#
|
901
|
-
# @overload migrate_key(name: nil)
|
902
|
+
# @overload migrate_key(name: nil, skip_billing_check: nil)
|
902
903
|
# Pass arguments to `migrate_key` via keyword arguments. Note that at
|
903
904
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
904
905
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -906,6 +907,15 @@ module Google
|
|
906
907
|
# @param name [::String]
|
907
908
|
# Required. The name of the key to be migrated, in the format
|
908
909
|
# "projects/\\{project}/keys/\\{key}".
|
910
|
+
# @param skip_billing_check [::Boolean]
|
911
|
+
# Optional. If true, skips the billing check.
|
912
|
+
# A reCAPTCHA Enterprise key or migrated key behaves differently than a
|
913
|
+
# reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see
|
914
|
+
# https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
|
915
|
+
# any disruption of your usage, we check that a billing account is present.
|
916
|
+
# If your usage of reCAPTCHA is under the free quota, you can safely skip the
|
917
|
+
# billing check and proceed with the migration. See
|
918
|
+
# https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
|
909
919
|
#
|
910
920
|
# @yield [response, operation] Access the result along with the RPC operation
|
911
921
|
# @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key]
|
@@ -1077,16 +1087,15 @@ module Google
|
|
1077
1087
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1078
1088
|
#
|
1079
1089
|
# @param parent [::String]
|
1080
|
-
# Required. The name of the project to list related account groups from, in
|
1081
|
-
# "projects/\\{project}".
|
1090
|
+
# Required. The name of the project to list related account groups from, in
|
1091
|
+
# the format "projects/\\{project}".
|
1082
1092
|
# @param page_size [::Integer]
|
1083
|
-
# Optional. The maximum number of groups to return. The service might return
|
1084
|
-
# this value.
|
1085
|
-
#
|
1086
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
1093
|
+
# Optional. The maximum number of groups to return. The service might return
|
1094
|
+
# fewer than this value. If unspecified, at most 50 groups are returned. The
|
1095
|
+
# maximum value is 1000; values above 1000 are coerced to 1000.
|
1087
1096
|
# @param page_token [::String]
|
1088
|
-
# Optional. A page token, received from a previous `ListRelatedAccountGroups`
|
1089
|
-
# Provide this to retrieve the subsequent page.
|
1097
|
+
# Optional. A page token, received from a previous `ListRelatedAccountGroups`
|
1098
|
+
# call. Provide this to retrieve the subsequent page.
|
1090
1099
|
#
|
1091
1100
|
# When paginating, all other parameters provided to
|
1092
1101
|
# `ListRelatedAccountGroups` must match the call that provided the page
|
@@ -1185,13 +1194,12 @@ module Google
|
|
1185
1194
|
# Required. The resource name for the related account group in the format
|
1186
1195
|
# `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
|
1187
1196
|
# @param page_size [::Integer]
|
1188
|
-
# Optional. The maximum number of accounts to return. The service might
|
1189
|
-
# than this value.
|
1190
|
-
#
|
1191
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
1197
|
+
# Optional. The maximum number of accounts to return. The service might
|
1198
|
+
# return fewer than this value. If unspecified, at most 50 accounts are
|
1199
|
+
# returned. The maximum value is 1000; values above 1000 are coerced to 1000.
|
1192
1200
|
# @param page_token [::String]
|
1193
|
-
# Optional. A page token, received from a previous
|
1194
|
-
# call.
|
1201
|
+
# Optional. A page token, received from a previous
|
1202
|
+
# `ListRelatedAccountGroupMemberships` call.
|
1195
1203
|
#
|
1196
1204
|
# When paginating, all other parameters provided to
|
1197
1205
|
# `ListRelatedAccountGroupMemberships` must match the call that provided the
|
@@ -1287,17 +1295,17 @@ module Google
|
|
1287
1295
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1288
1296
|
#
|
1289
1297
|
# @param project [::String]
|
1290
|
-
# Required. The name of the project to search related account group
|
1291
|
-
# Specify the project name in the following format:
|
1298
|
+
# Required. The name of the project to search related account group
|
1299
|
+
# memberships from. Specify the project name in the following format:
|
1300
|
+
# "projects/\\{project}".
|
1292
1301
|
# @param hashed_account_id [::String]
|
1293
|
-
# Optional. The unique stable hashed user identifier we should search
|
1294
|
-
# The identifier should correspond to a `hashed_account_id`
|
1295
|
-
# previous `CreateAssessment` or `AnnotateAssessment` call.
|
1302
|
+
# Optional. The unique stable hashed user identifier we should search
|
1303
|
+
# connections to. The identifier should correspond to a `hashed_account_id`
|
1304
|
+
# provided in a previous `CreateAssessment` or `AnnotateAssessment` call.
|
1296
1305
|
# @param page_size [::Integer]
|
1297
|
-
# Optional. The maximum number of groups to return. The service might return
|
1298
|
-
# this value.
|
1299
|
-
#
|
1300
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
1306
|
+
# Optional. The maximum number of groups to return. The service might return
|
1307
|
+
# fewer than this value. If unspecified, at most 50 groups are returned. The
|
1308
|
+
# maximum value is 1000; values above 1000 are coerced to 1000.
|
1301
1309
|
# @param page_token [::String]
|
1302
1310
|
# Optional. A page token, received from a previous
|
1303
1311
|
# `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
|
@@ -49,6 +49,32 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
49
49
|
end
|
50
50
|
add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse" do
|
51
51
|
end
|
52
|
+
add_message "google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo" do
|
53
|
+
optional :request_token, :string, 3
|
54
|
+
optional :last_verification_time, :message, 4, "google.protobuf.Timestamp"
|
55
|
+
oneof :endpoint do
|
56
|
+
optional :email_address, :string, 1
|
57
|
+
optional :phone_number, :string, 2
|
58
|
+
end
|
59
|
+
end
|
60
|
+
add_message "google.cloud.recaptchaenterprise.v1.AccountVerificationInfo" do
|
61
|
+
repeated :endpoints, :message, 1, "google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo"
|
62
|
+
optional :language_code, :string, 3
|
63
|
+
optional :latest_verification_result, :enum, 7, "google.cloud.recaptchaenterprise.v1.AccountVerificationInfo.Result"
|
64
|
+
optional :username, :string, 2
|
65
|
+
end
|
66
|
+
add_enum "google.cloud.recaptchaenterprise.v1.AccountVerificationInfo.Result" do
|
67
|
+
value :RESULT_UNSPECIFIED, 0
|
68
|
+
value :SUCCESS_USER_VERIFIED, 1
|
69
|
+
value :ERROR_USER_NOT_VERIFIED, 2
|
70
|
+
value :ERROR_SITE_ONBOARDING_INCOMPLETE, 3
|
71
|
+
value :ERROR_RECIPIENT_NOT_ALLOWED, 4
|
72
|
+
value :ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED, 5
|
73
|
+
value :ERROR_CRITICAL_INTERNAL, 6
|
74
|
+
value :ERROR_CUSTOMER_QUOTA_EXHAUSTED, 7
|
75
|
+
value :ERROR_VERIFICATION_BYPASSED, 8
|
76
|
+
value :ERROR_VERDICT_MISMATCH, 9
|
77
|
+
end
|
52
78
|
add_message "google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification" do
|
53
79
|
optional :lookup_hash_prefix, :bytes, 1
|
54
80
|
optional :encrypted_user_credentials_hash, :bytes, 2
|
@@ -60,6 +86,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
60
86
|
optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1.Event"
|
61
87
|
optional :risk_analysis, :message, 3, "google.cloud.recaptchaenterprise.v1.RiskAnalysis"
|
62
88
|
optional :token_properties, :message, 4, "google.cloud.recaptchaenterprise.v1.TokenProperties"
|
89
|
+
optional :account_verification, :message, 5, "google.cloud.recaptchaenterprise.v1.AccountVerificationInfo"
|
63
90
|
optional :account_defender_assessment, :message, 6, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment"
|
64
91
|
optional :private_password_leak_verification, :message, 8, "google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification"
|
65
92
|
end
|
@@ -88,6 +115,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
88
115
|
optional :invalid_reason, :enum, 2, "google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason"
|
89
116
|
optional :create_time, :message, 3, "google.protobuf.Timestamp"
|
90
117
|
optional :hostname, :string, 4
|
118
|
+
optional :android_package_name, :string, 8
|
119
|
+
optional :ios_bundle_id, :string, 9
|
91
120
|
optional :action, :string, 5
|
92
121
|
end
|
93
122
|
add_enum "google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason" do
|
@@ -137,6 +166,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
137
166
|
end
|
138
167
|
add_message "google.cloud.recaptchaenterprise.v1.MigrateKeyRequest" do
|
139
168
|
optional :name, :string, 1
|
169
|
+
optional :skip_billing_check, :bool, 2
|
140
170
|
end
|
141
171
|
add_message "google.cloud.recaptchaenterprise.v1.GetMetricsRequest" do
|
142
172
|
optional :name, :string, 1
|
@@ -273,6 +303,9 @@ module Google
|
|
273
303
|
AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation").enummodule
|
274
304
|
AnnotateAssessmentRequest::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason").enummodule
|
275
305
|
AnnotateAssessmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse").msgclass
|
306
|
+
EndpointVerificationInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.EndpointVerificationInfo").msgclass
|
307
|
+
AccountVerificationInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountVerificationInfo").msgclass
|
308
|
+
AccountVerificationInfo::Result = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountVerificationInfo.Result").enummodule
|
276
309
|
PrivatePasswordLeakVerification = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification").msgclass
|
277
310
|
Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Assessment").msgclass
|
278
311
|
Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Event").msgclass
|
@@ -0,0 +1,318 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to.
|
39
|
+
# @!attribute [rw] launch_stage
|
40
|
+
# @return [::Google::Api::LaunchStage]
|
41
|
+
# Launch stage of this version of the API.
|
42
|
+
# @!attribute [rw] rest_numeric_enums
|
43
|
+
# @return [::Boolean]
|
44
|
+
# When using transport=rest, the client request will encode enums as
|
45
|
+
# numbers rather than strings.
|
46
|
+
# @!attribute [rw] java_settings
|
47
|
+
# @return [::Google::Api::JavaSettings]
|
48
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
49
|
+
# @!attribute [rw] cpp_settings
|
50
|
+
# @return [::Google::Api::CppSettings]
|
51
|
+
# Settings for C++ client libraries.
|
52
|
+
# @!attribute [rw] php_settings
|
53
|
+
# @return [::Google::Api::PhpSettings]
|
54
|
+
# Settings for PHP client libraries.
|
55
|
+
# @!attribute [rw] python_settings
|
56
|
+
# @return [::Google::Api::PythonSettings]
|
57
|
+
# Settings for Python client libraries.
|
58
|
+
# @!attribute [rw] node_settings
|
59
|
+
# @return [::Google::Api::NodeSettings]
|
60
|
+
# Settings for Node client libraries.
|
61
|
+
# @!attribute [rw] dotnet_settings
|
62
|
+
# @return [::Google::Api::DotnetSettings]
|
63
|
+
# Settings for .NET client libraries.
|
64
|
+
# @!attribute [rw] ruby_settings
|
65
|
+
# @return [::Google::Api::RubySettings]
|
66
|
+
# Settings for Ruby client libraries.
|
67
|
+
# @!attribute [rw] go_settings
|
68
|
+
# @return [::Google::Api::GoSettings]
|
69
|
+
# Settings for Go client libraries.
|
70
|
+
class ClientLibrarySettings
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# This message configures the settings for publishing [Google Cloud Client
|
76
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
77
|
+
# generated from the service config.
|
78
|
+
# @!attribute [rw] method_settings
|
79
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
80
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
81
|
+
# long-running operation pattern.
|
82
|
+
# @!attribute [rw] new_issue_uri
|
83
|
+
# @return [::String]
|
84
|
+
# Link to a place that API users can report issues. Example:
|
85
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
86
|
+
# @!attribute [rw] documentation_uri
|
87
|
+
# @return [::String]
|
88
|
+
# Link to product home page. Example:
|
89
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
90
|
+
# @!attribute [rw] api_short_name
|
91
|
+
# @return [::String]
|
92
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
93
|
+
# relations artifacts like docs, packages delivered to package managers,
|
94
|
+
# etc. Example: "speech".
|
95
|
+
# @!attribute [rw] github_label
|
96
|
+
# @return [::String]
|
97
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
98
|
+
# @!attribute [rw] codeowner_github_teams
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
101
|
+
# containing source code for the client libraries for this API.
|
102
|
+
# @!attribute [rw] doc_tag_prefix
|
103
|
+
# @return [::String]
|
104
|
+
# A prefix used in sample code when demarking regions to be included in
|
105
|
+
# documentation.
|
106
|
+
# @!attribute [rw] organization
|
107
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
108
|
+
# For whom the client library is being published.
|
109
|
+
# @!attribute [rw] library_settings
|
110
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
111
|
+
# Client library settings. If the same version string appears multiple
|
112
|
+
# times in this list, then the last one wins. Settings from earlier
|
113
|
+
# settings with the same version string are discarded.
|
114
|
+
class Publishing
|
115
|
+
include ::Google::Protobuf::MessageExts
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
|
+
end
|
118
|
+
|
119
|
+
# Settings for Java client libraries.
|
120
|
+
# @!attribute [rw] library_package
|
121
|
+
# @return [::String]
|
122
|
+
# The package name to use in Java. Clobbers the java_package option
|
123
|
+
# set in the protobuf. This should be used **only** by APIs
|
124
|
+
# who have already set the language_settings.java.package_name" field
|
125
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
126
|
+
# where possible.
|
127
|
+
#
|
128
|
+
# Example of a YAML configuration::
|
129
|
+
#
|
130
|
+
# publishing:
|
131
|
+
# java_settings:
|
132
|
+
# library_package: com.google.cloud.pubsub.v1
|
133
|
+
# @!attribute [rw] service_class_names
|
134
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
135
|
+
# Configure the Java class name to use instead of the service's for its
|
136
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
137
|
+
# service names as they appear in the protobuf (including the full
|
138
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
139
|
+
# teams should otherwise use the service name as it appears in the
|
140
|
+
# protobuf.
|
141
|
+
#
|
142
|
+
# Example of a YAML configuration::
|
143
|
+
#
|
144
|
+
# publishing:
|
145
|
+
# java_settings:
|
146
|
+
# service_class_names:
|
147
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
148
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
149
|
+
# @!attribute [rw] common
|
150
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
151
|
+
# Some settings.
|
152
|
+
class JavaSettings
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
|
156
|
+
# @!attribute [rw] key
|
157
|
+
# @return [::String]
|
158
|
+
# @!attribute [rw] value
|
159
|
+
# @return [::String]
|
160
|
+
class ServiceClassNamesEntry
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Settings for C++ client libraries.
|
167
|
+
# @!attribute [rw] common
|
168
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
169
|
+
# Some settings.
|
170
|
+
class CppSettings
|
171
|
+
include ::Google::Protobuf::MessageExts
|
172
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
173
|
+
end
|
174
|
+
|
175
|
+
# Settings for Php client libraries.
|
176
|
+
# @!attribute [rw] common
|
177
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
178
|
+
# Some settings.
|
179
|
+
class PhpSettings
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# Settings for Python client libraries.
|
185
|
+
# @!attribute [rw] common
|
186
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
187
|
+
# Some settings.
|
188
|
+
class PythonSettings
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Settings for Node client libraries.
|
194
|
+
# @!attribute [rw] common
|
195
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
196
|
+
# Some settings.
|
197
|
+
class NodeSettings
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Settings for Dotnet client libraries.
|
203
|
+
# @!attribute [rw] common
|
204
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
205
|
+
# Some settings.
|
206
|
+
class DotnetSettings
|
207
|
+
include ::Google::Protobuf::MessageExts
|
208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
|
+
end
|
210
|
+
|
211
|
+
# Settings for Ruby client libraries.
|
212
|
+
# @!attribute [rw] common
|
213
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
214
|
+
# Some settings.
|
215
|
+
class RubySettings
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
|
220
|
+
# Settings for Go client libraries.
|
221
|
+
# @!attribute [rw] common
|
222
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
223
|
+
# Some settings.
|
224
|
+
class GoSettings
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
|
229
|
+
# Describes the generator configuration for a method.
|
230
|
+
# @!attribute [rw] selector
|
231
|
+
# @return [::String]
|
232
|
+
# The fully qualified name of the method, for which the options below apply.
|
233
|
+
# This is used to find the method to apply the options.
|
234
|
+
# @!attribute [rw] long_running
|
235
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
236
|
+
# Describes settings to use for long-running operations when generating
|
237
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
238
|
+
# google/longrunning/operations.proto.
|
239
|
+
#
|
240
|
+
# Example of a YAML configuration::
|
241
|
+
#
|
242
|
+
# publishing:
|
243
|
+
# method_behavior:
|
244
|
+
# - selector: CreateAdDomain
|
245
|
+
# long_running:
|
246
|
+
# initial_poll_delay:
|
247
|
+
# seconds: 60 # 1 minute
|
248
|
+
# poll_delay_multiplier: 1.5
|
249
|
+
# max_poll_delay:
|
250
|
+
# seconds: 360 # 6 minutes
|
251
|
+
# total_poll_timeout:
|
252
|
+
# seconds: 54000 # 90 minutes
|
253
|
+
class MethodSettings
|
254
|
+
include ::Google::Protobuf::MessageExts
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
256
|
+
|
257
|
+
# Describes settings to use when generating API methods that use the
|
258
|
+
# long-running operation pattern.
|
259
|
+
# All default values below are from those used in the client library
|
260
|
+
# generators (e.g.
|
261
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
262
|
+
# @!attribute [rw] initial_poll_delay
|
263
|
+
# @return [::Google::Protobuf::Duration]
|
264
|
+
# Initial delay after which the first poll request will be made.
|
265
|
+
# Default value: 5 seconds.
|
266
|
+
# @!attribute [rw] poll_delay_multiplier
|
267
|
+
# @return [::Float]
|
268
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
269
|
+
# reaches max_poll_delay.
|
270
|
+
# Default value: 1.5.
|
271
|
+
# @!attribute [rw] max_poll_delay
|
272
|
+
# @return [::Google::Protobuf::Duration]
|
273
|
+
# Maximum time between two subsequent poll requests.
|
274
|
+
# Default value: 45 seconds.
|
275
|
+
# @!attribute [rw] total_poll_timeout
|
276
|
+
# @return [::Google::Protobuf::Duration]
|
277
|
+
# Total polling timeout.
|
278
|
+
# Default value: 5 minutes.
|
279
|
+
class LongRunning
|
280
|
+
include ::Google::Protobuf::MessageExts
|
281
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# The organization for which the client libraries are being published.
|
286
|
+
# Affects the url where generated docs are published, etc.
|
287
|
+
module ClientLibraryOrganization
|
288
|
+
# Not useful.
|
289
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
290
|
+
|
291
|
+
# Google Cloud Platform Org.
|
292
|
+
CLOUD = 1
|
293
|
+
|
294
|
+
# Ads (Advertising) Org.
|
295
|
+
ADS = 2
|
296
|
+
|
297
|
+
# Photos Org.
|
298
|
+
PHOTOS = 3
|
299
|
+
|
300
|
+
# Street View Org.
|
301
|
+
STREET_VIEW = 4
|
302
|
+
end
|
303
|
+
|
304
|
+
# To where should client libraries be published?
|
305
|
+
module ClientLibraryDestination
|
306
|
+
# Client libraries will neither be generated nor published to package
|
307
|
+
# managers.
|
308
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
309
|
+
|
310
|
+
# Generate the client library in a repo under github.com/googleapis,
|
311
|
+
# but don't publish it to package managers.
|
312
|
+
GITHUB = 10
|
313
|
+
|
314
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
315
|
+
PACKAGE_MANAGER = 20
|
316
|
+
end
|
317
|
+
end
|
318
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# The launch stage as defined by [Google Cloud Platform
|
23
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
24
|
+
module LaunchStage
|
25
|
+
# Do not use this default value.
|
26
|
+
LAUNCH_STAGE_UNSPECIFIED = 0
|
27
|
+
|
28
|
+
# The feature is not yet implemented. Users can not use it.
|
29
|
+
UNIMPLEMENTED = 6
|
30
|
+
|
31
|
+
# Prelaunch features are hidden from users and are only visible internally.
|
32
|
+
PRELAUNCH = 7
|
33
|
+
|
34
|
+
# Early Access features are limited to a closed group of testers. To use
|
35
|
+
# these features, you must sign up in advance and sign a Trusted Tester
|
36
|
+
# agreement (which includes confidentiality provisions). These features may
|
37
|
+
# be unstable, changed in backward-incompatible ways, and are not
|
38
|
+
# guaranteed to be released.
|
39
|
+
EARLY_ACCESS = 1
|
40
|
+
|
41
|
+
# Alpha is a limited availability test for releases before they are cleared
|
42
|
+
# for widespread use. By Alpha, all significant design issues are resolved
|
43
|
+
# and we are in the process of verifying functionality. Alpha customers
|
44
|
+
# need to apply for access, agree to applicable terms, and have their
|
45
|
+
# projects allowlisted. Alpha releases don't have to be feature complete,
|
46
|
+
# no SLAs are provided, and there are no technical support obligations, but
|
47
|
+
# they will be far enough along that customers can actually use them in
|
48
|
+
# test environments or for limited-use tests -- just like they would in
|
49
|
+
# normal production cases.
|
50
|
+
ALPHA = 2
|
51
|
+
|
52
|
+
# Beta is the point at which we are ready to open a release for any
|
53
|
+
# customer to use. There are no SLA or technical support obligations in a
|
54
|
+
# Beta release. Products will be complete from a feature perspective, but
|
55
|
+
# may have some open outstanding issues. Beta releases are suitable for
|
56
|
+
# limited production use cases.
|
57
|
+
BETA = 3
|
58
|
+
|
59
|
+
# GA features are open to all developers and are considered stable and
|
60
|
+
# fully qualified for production use.
|
61
|
+
GA = 4
|
62
|
+
|
63
|
+
# Deprecated features are scheduled to be shut down and removed. For more
|
64
|
+
# information, see the "Deprecation Policy" section of our [Terms of
|
65
|
+
# Service](https://cloud.google.com/terms/)
|
66
|
+
# and the [Google Cloud Platform Subject to the Deprecation
|
67
|
+
# Policy](https://cloud.google.com/terms/deprecation) documentation.
|
68
|
+
DEPRECATED = 5
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -41,12 +41,13 @@ module Google
|
|
41
41
|
# "projects/\\{project}/assessments/\\{assessment}".
|
42
42
|
# @!attribute [rw] annotation
|
43
43
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
|
44
|
-
# Optional. The annotation that will be assigned to the Event. This field can
|
45
|
-
# empty to provide reasons that apply to an event without concluding
|
46
|
-
# the event is legitimate or fraudulent.
|
44
|
+
# Optional. The annotation that will be assigned to the Event. This field can
|
45
|
+
# be left empty to provide reasons that apply to an event without concluding
|
46
|
+
# whether the event is legitimate or fraudulent.
|
47
47
|
# @!attribute [rw] reasons
|
48
48
|
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
|
49
|
-
# Optional. Optional reasons for the annotation that will be assigned to the
|
49
|
+
# Optional. Optional reasons for the annotation that will be assigned to the
|
50
|
+
# Event.
|
50
51
|
# @!attribute [rw] hashed_account_id
|
51
52
|
# @return [::String]
|
52
53
|
# Optional. Unique stable hashed user identifier to apply to the assessment.
|
@@ -152,26 +153,111 @@ module Google
|
|
152
153
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
153
154
|
end
|
154
155
|
|
156
|
+
# Information about a verification endpoint that can be used for 2FA.
|
157
|
+
# @!attribute [rw] email_address
|
158
|
+
# @return [::String]
|
159
|
+
# Email address for which to trigger a verification request.
|
160
|
+
# @!attribute [rw] phone_number
|
161
|
+
# @return [::String]
|
162
|
+
# Phone number for which to trigger a verification request. Should be given
|
163
|
+
# in E.164 format.
|
164
|
+
# @!attribute [r] request_token
|
165
|
+
# @return [::String]
|
166
|
+
# Output only. Token to provide to the client to trigger endpoint
|
167
|
+
# verification. It must be used within 15 minutes.
|
168
|
+
# @!attribute [r] last_verification_time
|
169
|
+
# @return [::Google::Protobuf::Timestamp]
|
170
|
+
# Output only. Timestamp of the last successful verification for the
|
171
|
+
# endpoint, if any.
|
172
|
+
class EndpointVerificationInfo
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
|
177
|
+
# Information about account verification, used for identity verification.
|
178
|
+
# @!attribute [rw] endpoints
|
179
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::EndpointVerificationInfo>]
|
180
|
+
# Endpoints that can be used for identity verification.
|
181
|
+
# @!attribute [rw] language_code
|
182
|
+
# @return [::String]
|
183
|
+
# Language code preference for the verification message, set as a IETF BCP 47
|
184
|
+
# language code.
|
185
|
+
# @!attribute [r] latest_verification_result
|
186
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo::Result]
|
187
|
+
# Output only. Result of the latest account verification challenge.
|
188
|
+
# @!attribute [rw] username
|
189
|
+
# @return [::String]
|
190
|
+
# Username of the account that is being verified. Deprecated. Customers
|
191
|
+
# should now provide the hashed account ID field in Event.
|
192
|
+
class AccountVerificationInfo
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
|
196
|
+
# Result of the account verification as contained in the verdict token issued
|
197
|
+
# at the end of the verification flow.
|
198
|
+
module Result
|
199
|
+
# No information about the latest account verification.
|
200
|
+
RESULT_UNSPECIFIED = 0
|
201
|
+
|
202
|
+
# The user was successfully verified. This means the account verification
|
203
|
+
# challenge was successfully completed.
|
204
|
+
SUCCESS_USER_VERIFIED = 1
|
205
|
+
|
206
|
+
# The user failed the verification challenge.
|
207
|
+
ERROR_USER_NOT_VERIFIED = 2
|
208
|
+
|
209
|
+
# The site is not properly onboarded to use the account verification
|
210
|
+
# feature.
|
211
|
+
ERROR_SITE_ONBOARDING_INCOMPLETE = 3
|
212
|
+
|
213
|
+
# The recipient is not allowed for account verification. This can occur
|
214
|
+
# during integration but should not occur in production.
|
215
|
+
ERROR_RECIPIENT_NOT_ALLOWED = 4
|
216
|
+
|
217
|
+
# The recipient has already been sent too many verification codes in a
|
218
|
+
# short amount of time.
|
219
|
+
ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5
|
220
|
+
|
221
|
+
# The verification flow could not be completed due to a critical internal
|
222
|
+
# error.
|
223
|
+
ERROR_CRITICAL_INTERNAL = 6
|
224
|
+
|
225
|
+
# The client has exceeded their two factor request quota for this period of
|
226
|
+
# time.
|
227
|
+
ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7
|
228
|
+
|
229
|
+
# The request cannot be processed at the time because of an incident. This
|
230
|
+
# bypass can be restricted to a problematic destination email domain, a
|
231
|
+
# customer, or could affect the entire service.
|
232
|
+
ERROR_VERIFICATION_BYPASSED = 8
|
233
|
+
|
234
|
+
# The request parameters do not match with the token provided and cannot be
|
235
|
+
# processed.
|
236
|
+
ERROR_VERDICT_MISMATCH = 9
|
237
|
+
end
|
238
|
+
end
|
239
|
+
|
155
240
|
# Private password leak verification info.
|
156
241
|
# @!attribute [rw] lookup_hash_prefix
|
157
242
|
# @return [::String]
|
158
|
-
# Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
|
159
|
-
# is used to look up password leaks associated with that hash
|
243
|
+
# Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
|
244
|
+
# username. It is used to look up password leaks associated with that hash
|
245
|
+
# prefix.
|
160
246
|
# @!attribute [rw] encrypted_user_credentials_hash
|
161
247
|
# @return [::String]
|
162
|
-
# Optional. Encrypted Scrypt hash of the canonicalized username+password. It
|
163
|
-
# re-encrypted by the server and returned through
|
248
|
+
# Optional. Encrypted Scrypt hash of the canonicalized username+password. It
|
249
|
+
# is re-encrypted by the server and returned through
|
164
250
|
# `reencrypted_user_credentials_hash`.
|
165
251
|
# @!attribute [r] encrypted_leak_match_prefixes
|
166
252
|
# @return [::Array<::String>]
|
167
|
-
# Output only. List of prefixes of the encrypted potential password leaks
|
168
|
-
# given parameters. They must be compared with the
|
169
|
-
# prefix of `reencrypted_user_credentials_hash`
|
253
|
+
# Output only. List of prefixes of the encrypted potential password leaks
|
254
|
+
# that matched the given parameters. They must be compared with the
|
255
|
+
# client-side decryption prefix of `reencrypted_user_credentials_hash`
|
170
256
|
# @!attribute [r] reencrypted_user_credentials_hash
|
171
257
|
# @return [::String]
|
172
|
-
# Output only. Corresponds to the re-encryption of the
|
173
|
-
# field. It is used to match potential
|
174
|
-
# `encrypted_leak_match_prefixes`.
|
258
|
+
# Output only. Corresponds to the re-encryption of the
|
259
|
+
# `encrypted_user_credentials_hash` field. It is used to match potential
|
260
|
+
# password leaks within `encrypted_leak_match_prefixes`.
|
175
261
|
class PrivatePasswordLeakVerification
|
176
262
|
include ::Google::Protobuf::MessageExts
|
177
263
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -191,6 +277,10 @@ module Google
|
|
191
277
|
# @!attribute [r] token_properties
|
192
278
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties]
|
193
279
|
# Output only. Properties of the provided event token.
|
280
|
+
# @!attribute [rw] account_verification
|
281
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo]
|
282
|
+
# Account verification information for identity verification. The assessment
|
283
|
+
# event must include a token and site key to use this feature.
|
194
284
|
# @!attribute [rw] account_defender_assessment
|
195
285
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
|
196
286
|
# Assessment returned by account defender when a hashed_account_id is
|
@@ -206,28 +296,29 @@ module Google
|
|
206
296
|
|
207
297
|
# @!attribute [rw] token
|
208
298
|
# @return [::String]
|
209
|
-
# Optional. The user response token provided by the reCAPTCHA client-side
|
210
|
-
# on your site.
|
299
|
+
# Optional. The user response token provided by the reCAPTCHA client-side
|
300
|
+
# integration on your site.
|
211
301
|
# @!attribute [rw] site_key
|
212
302
|
# @return [::String]
|
213
|
-
# Optional. The site key that was used to invoke reCAPTCHA on your site and
|
214
|
-
# the token.
|
303
|
+
# Optional. The site key that was used to invoke reCAPTCHA on your site and
|
304
|
+
# generate the token.
|
215
305
|
# @!attribute [rw] user_agent
|
216
306
|
# @return [::String]
|
217
|
-
# Optional. The user agent present in the request from the user's device
|
218
|
-
# this event.
|
307
|
+
# Optional. The user agent present in the request from the user's device
|
308
|
+
# related to this event.
|
219
309
|
# @!attribute [rw] user_ip_address
|
220
310
|
# @return [::String]
|
221
|
-
# Optional. The IP address in the request from the user's device related to
|
311
|
+
# Optional. The IP address in the request from the user's device related to
|
312
|
+
# this event.
|
222
313
|
# @!attribute [rw] expected_action
|
223
314
|
# @return [::String]
|
224
|
-
# Optional. The expected action for this type of event. This should be the
|
225
|
-
# provided at token generation time on client-side platforms
|
226
|
-
# integrated with recaptcha enterprise.
|
315
|
+
# Optional. The expected action for this type of event. This should be the
|
316
|
+
# same action provided at token generation time on client-side platforms
|
317
|
+
# already integrated with recaptcha enterprise.
|
227
318
|
# @!attribute [rw] hashed_account_id
|
228
319
|
# @return [::String]
|
229
|
-
# Optional. Unique stable hashed user identifier for the request. The
|
230
|
-
# be hashed using hmac-sha256 with stable secret.
|
320
|
+
# Optional. Unique stable hashed user identifier for the request. The
|
321
|
+
# identifier must be hashed using hmac-sha256 with stable secret.
|
231
322
|
class Event
|
232
323
|
include ::Google::Protobuf::MessageExts
|
233
324
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -286,6 +377,14 @@ module Google
|
|
286
377
|
# @!attribute [rw] hostname
|
287
378
|
# @return [::String]
|
288
379
|
# The hostname of the page on which the token was generated (Web keys only).
|
380
|
+
# @!attribute [rw] android_package_name
|
381
|
+
# @return [::String]
|
382
|
+
# The name of the Android package with which the token was generated (Android
|
383
|
+
# keys only).
|
384
|
+
# @!attribute [rw] ios_bundle_id
|
385
|
+
# @return [::String]
|
386
|
+
# The ID of the iOS bundle with which the token was generated (iOS keys
|
387
|
+
# only).
|
289
388
|
# @!attribute [rw] action
|
290
389
|
# @return [::String]
|
291
390
|
# Action name provided at token generation.
|
@@ -397,8 +496,8 @@ module Google
|
|
397
496
|
# The retrieve legacy secret key request message.
|
398
497
|
# @!attribute [rw] key
|
399
498
|
# @return [::String]
|
400
|
-
# Required. The public key name linked to the requested secret key in the
|
401
|
-
# "projects/\\{project}/keys/\\{key}".
|
499
|
+
# Required. The public key name linked to the requested secret key in the
|
500
|
+
# format "projects/\\{project}/keys/\\{key}".
|
402
501
|
class RetrieveLegacySecretKeyRequest
|
403
502
|
include ::Google::Protobuf::MessageExts
|
404
503
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -420,8 +519,8 @@ module Google
|
|
420
519
|
# Required. The key to update.
|
421
520
|
# @!attribute [rw] update_mask
|
422
521
|
# @return [::Google::Protobuf::FieldMask]
|
423
|
-
# Optional. The mask to control which fields of the key get updated. If the
|
424
|
-
# present, all fields will be updated.
|
522
|
+
# Optional. The mask to control which fields of the key get updated. If the
|
523
|
+
# mask is not present, all fields will be updated.
|
425
524
|
class UpdateKeyRequest
|
426
525
|
include ::Google::Protobuf::MessageExts
|
427
526
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -442,6 +541,16 @@ module Google
|
|
442
541
|
# @return [::String]
|
443
542
|
# Required. The name of the key to be migrated, in the format
|
444
543
|
# "projects/\\{project}/keys/\\{key}".
|
544
|
+
# @!attribute [rw] skip_billing_check
|
545
|
+
# @return [::Boolean]
|
546
|
+
# Optional. If true, skips the billing check.
|
547
|
+
# A reCAPTCHA Enterprise key or migrated key behaves differently than a
|
548
|
+
# reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see
|
549
|
+
# https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
|
550
|
+
# any disruption of your usage, we check that a billing account is present.
|
551
|
+
# If your usage of reCAPTCHA is under the free quota, you can safely skip the
|
552
|
+
# billing check and proceed with the migration. See
|
553
|
+
# https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
|
445
554
|
class MigrateKeyRequest
|
446
555
|
include ::Google::Protobuf::MessageExts
|
447
556
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -685,7 +794,6 @@ module Google
|
|
685
794
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution}]
|
686
795
|
# Action-based metrics. The map key is the action name which specified by the
|
687
796
|
# site owners at time of the "execute" client-side call.
|
688
|
-
# Populated only for SCORE keys.
|
689
797
|
class ScoreMetrics
|
690
798
|
include ::Google::Protobuf::MessageExts
|
691
799
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -729,14 +837,13 @@ module Google
|
|
729
837
|
# `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
|
730
838
|
# @!attribute [rw] page_size
|
731
839
|
# @return [::Integer]
|
732
|
-
# Optional. The maximum number of accounts to return. The service might
|
733
|
-
# than this value.
|
734
|
-
#
|
735
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
840
|
+
# Optional. The maximum number of accounts to return. The service might
|
841
|
+
# return fewer than this value. If unspecified, at most 50 accounts are
|
842
|
+
# returned. The maximum value is 1000; values above 1000 are coerced to 1000.
|
736
843
|
# @!attribute [rw] page_token
|
737
844
|
# @return [::String]
|
738
|
-
# Optional. A page token, received from a previous
|
739
|
-
# call.
|
845
|
+
# Optional. A page token, received from a previous
|
846
|
+
# `ListRelatedAccountGroupMemberships` call.
|
740
847
|
#
|
741
848
|
# When paginating, all other parameters provided to
|
742
849
|
# `ListRelatedAccountGroupMemberships` must match the call that provided the
|
@@ -762,18 +869,17 @@ module Google
|
|
762
869
|
# The request message to list related account groups.
|
763
870
|
# @!attribute [rw] parent
|
764
871
|
# @return [::String]
|
765
|
-
# Required. The name of the project to list related account groups from, in
|
766
|
-
# "projects/\\{project}".
|
872
|
+
# Required. The name of the project to list related account groups from, in
|
873
|
+
# the format "projects/\\{project}".
|
767
874
|
# @!attribute [rw] page_size
|
768
875
|
# @return [::Integer]
|
769
|
-
# Optional. The maximum number of groups to return. The service might return
|
770
|
-
# this value.
|
771
|
-
#
|
772
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
876
|
+
# Optional. The maximum number of groups to return. The service might return
|
877
|
+
# fewer than this value. If unspecified, at most 50 groups are returned. The
|
878
|
+
# maximum value is 1000; values above 1000 are coerced to 1000.
|
773
879
|
# @!attribute [rw] page_token
|
774
880
|
# @return [::String]
|
775
|
-
# Optional. A page token, received from a previous `ListRelatedAccountGroups`
|
776
|
-
# Provide this to retrieve the subsequent page.
|
881
|
+
# Optional. A page token, received from a previous `ListRelatedAccountGroups`
|
882
|
+
# call. Provide this to retrieve the subsequent page.
|
777
883
|
#
|
778
884
|
# When paginating, all other parameters provided to
|
779
885
|
# `ListRelatedAccountGroups` must match the call that provided the page
|
@@ -799,19 +905,19 @@ module Google
|
|
799
905
|
# The request message to search related account group memberships.
|
800
906
|
# @!attribute [rw] project
|
801
907
|
# @return [::String]
|
802
|
-
# Required. The name of the project to search related account group
|
803
|
-
# Specify the project name in the following format:
|
908
|
+
# Required. The name of the project to search related account group
|
909
|
+
# memberships from. Specify the project name in the following format:
|
910
|
+
# "projects/\\{project}".
|
804
911
|
# @!attribute [rw] hashed_account_id
|
805
912
|
# @return [::String]
|
806
|
-
# Optional. The unique stable hashed user identifier we should search
|
807
|
-
# The identifier should correspond to a `hashed_account_id`
|
808
|
-
# previous `CreateAssessment` or `AnnotateAssessment` call.
|
913
|
+
# Optional. The unique stable hashed user identifier we should search
|
914
|
+
# connections to. The identifier should correspond to a `hashed_account_id`
|
915
|
+
# provided in a previous `CreateAssessment` or `AnnotateAssessment` call.
|
809
916
|
# @!attribute [rw] page_size
|
810
917
|
# @return [::Integer]
|
811
|
-
# Optional. The maximum number of groups to return. The service might return
|
812
|
-
# this value.
|
813
|
-
#
|
814
|
-
# The maximum value is 1000; values above 1000 are coerced to 1000.
|
918
|
+
# Optional. The maximum number of groups to return. The service might return
|
919
|
+
# fewer than this value. If unspecified, at most 50 groups are returned. The
|
920
|
+
# maximum value is 1000; values above 1000 are coerced to 1000.
|
815
921
|
# @!attribute [rw] page_token
|
816
922
|
# @return [::String]
|
817
923
|
# Optional. A page token, received from a previous
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Protobuf
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
28
|
+
#
|
29
|
+
# # Examples
|
30
|
+
#
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
32
|
+
#
|
33
|
+
# Timestamp start = ...;
|
34
|
+
# Timestamp end = ...;
|
35
|
+
# Duration duration = ...;
|
36
|
+
#
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
39
|
+
#
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
41
|
+
# duration.seconds += 1;
|
42
|
+
# duration.nanos -= 1000000000;
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
44
|
+
# duration.seconds -= 1;
|
45
|
+
# duration.nanos += 1000000000;
|
46
|
+
# }
|
47
|
+
#
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
49
|
+
#
|
50
|
+
# Timestamp start = ...;
|
51
|
+
# Duration duration = ...;
|
52
|
+
# Timestamp end = ...;
|
53
|
+
#
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
56
|
+
#
|
57
|
+
# if (end.nanos < 0) {
|
58
|
+
# end.seconds -= 1;
|
59
|
+
# end.nanos += 1000000000;
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
61
|
+
# end.seconds += 1;
|
62
|
+
# end.nanos -= 1000000000;
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
66
|
+
#
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
68
|
+
# duration = Duration()
|
69
|
+
# duration.FromTimedelta(td)
|
70
|
+
#
|
71
|
+
# # JSON Mapping
|
72
|
+
#
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
80
|
+
# @!attribute [rw] seconds
|
81
|
+
# @return [::Integer]
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
85
|
+
# @!attribute [rw] nanos
|
86
|
+
# @return [::Integer]
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
92
|
+
# to +999,999,999 inclusive.
|
93
|
+
class Duration
|
94
|
+
include ::Google::Protobuf::MessageExts
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-recaptcha_enterprise-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.12.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-12-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -179,9 +179,12 @@ files:
|
|
179
179
|
- lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_pb.rb
|
180
180
|
- lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_services_pb.rb
|
181
181
|
- proto_docs/README.md
|
182
|
+
- proto_docs/google/api/client.rb
|
182
183
|
- proto_docs/google/api/field_behavior.rb
|
184
|
+
- proto_docs/google/api/launch_stage.rb
|
183
185
|
- proto_docs/google/api/resource.rb
|
184
186
|
- proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb
|
187
|
+
- proto_docs/google/protobuf/duration.rb
|
185
188
|
- proto_docs/google/protobuf/empty.rb
|
186
189
|
- proto_docs/google/protobuf/field_mask.rb
|
187
190
|
- proto_docs/google/protobuf/timestamp.rb
|