google-cloud-recaptcha_enterprise-v1beta1 0.1.0 → 0.1.1

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.
@@ -24,7 +24,7 @@ module Google
24
24
  module V1beta1
25
25
  module RecaptchaEnterpriseService
26
26
  # Credentials for the RecaptchaEnterpriseServiceV1Beta1 API.
27
- class Credentials < Google::Auth::Credentials
27
+ class Credentials < ::Google::Auth::Credentials
28
28
  self.scope = [
29
29
  "https://www.googleapis.com/auth/cloud-platform"
30
30
  ]
@@ -34,9 +34,9 @@ module Google
34
34
  # @param project [String]
35
35
  # @param assessment [String]
36
36
  #
37
- # @return [String]
37
+ # @return [::String]
38
38
  def assessment_path project:, assessment:
39
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
39
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
40
40
 
41
41
  "projects/#{project}/assessments/#{assessment}"
42
42
  end
@@ -51,9 +51,9 @@ module Google
51
51
  # @param project [String]
52
52
  # @param key [String]
53
53
  #
54
- # @return [String]
54
+ # @return [::String]
55
55
  def key_path project:, key:
56
- raise ArgumentError, "project cannot contain /" if project.to_s.include? "/"
56
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
57
57
 
58
58
  "projects/#{project}/keys/#{key}"
59
59
  end
@@ -67,7 +67,7 @@ module Google
67
67
  #
68
68
  # @param project [String]
69
69
  #
70
- # @return [String]
70
+ # @return [::String]
71
71
  def project_path project:
72
72
  "projects/#{project}"
73
73
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module RecaptchaEnterprise
23
23
  module V1beta1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.1.1"
25
25
  end
26
26
  end
27
27
  end
@@ -128,7 +128,7 @@ module Google
128
128
  # - pattern: "shelves/{shelf}"
129
129
  # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
130
  # @!attribute [rw] type
131
- # @return [String]
131
+ # @return [::String]
132
132
  # The resource type. It must be in the format of
133
133
  # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
134
  # singular and must not include version numbers.
@@ -140,7 +140,7 @@ module Google
140
140
  # should use PascalCase (UpperCamelCase). The maximum number of
141
141
  # characters allowed for the `resource_type_kind` is 100.
142
142
  # @!attribute [rw] pattern
143
- # @return [Array<String>]
143
+ # @return [::Array<::String>]
144
144
  # Optional. The relative resource name pattern associated with this resource
145
145
  # type. The DNS prefix of the full resource name shouldn't be specified here.
146
146
  #
@@ -161,11 +161,11 @@ module Google
161
161
  # the same component name (e.g. "project") refers to IDs of the same
162
162
  # type of resource.
163
163
  # @!attribute [rw] name_field
164
- # @return [String]
164
+ # @return [::String]
165
165
  # Optional. The field on the resource that designates the resource name
166
166
  # field. If omitted, this is assumed to be "name".
167
167
  # @!attribute [rw] history
168
- # @return [Google::Api::ResourceDescriptor::History]
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
169
  # Optional. The historical or future-looking state of the resource pattern.
170
170
  #
171
171
  # Example:
@@ -182,19 +182,19 @@ module Google
182
182
  # };
183
183
  # }
184
184
  # @!attribute [rw] plural
185
- # @return [String]
185
+ # @return [::String]
186
186
  # The plural name used in the resource name, such as 'projects' for
187
187
  # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
188
  # field in k8s CRD spec
189
189
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
190
  # @!attribute [rw] singular
191
- # @return [String]
191
+ # @return [::String]
192
192
  # The same concept of the `singular` field in k8s CRD spec
193
193
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
194
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
195
  class ResourceDescriptor
196
- include Google::Protobuf::MessageExts
197
- extend Google::Protobuf::MessageExts::ClassMethods
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
198
 
199
199
  # A description of the historical or future-looking state of the
200
200
  # resource pattern.
@@ -216,7 +216,7 @@ module Google
216
216
  # Defines a proto annotation that describes a string field that refers to
217
217
  # an API resource.
218
218
  # @!attribute [rw] type
219
- # @return [String]
219
+ # @return [::String]
220
220
  # The resource type that the annotated field references.
221
221
  #
222
222
  # Example:
@@ -227,7 +227,7 @@ module Google
227
227
  # }];
228
228
  # }
229
229
  # @!attribute [rw] child_type
230
- # @return [String]
230
+ # @return [::String]
231
231
  # The resource type of a child collection that the annotated field
232
232
  # references. This is useful for annotating the `parent` field that
233
233
  # doesn't have a fixed resource type.
@@ -240,8 +240,8 @@ module Google
240
240
  # };
241
241
  # }
242
242
  class ResourceReference
243
- include Google::Protobuf::MessageExts
244
- extend Google::Protobuf::MessageExts::ClassMethods
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
245
  end
246
246
  end
247
247
  end
@@ -23,28 +23,28 @@ module Google
23
23
  module V1beta1
24
24
  # The create assessment request message.
25
25
  # @!attribute [rw] parent
26
- # @return [String]
26
+ # @return [::String]
27
27
  # Required. The name of the project in which the assessment will be created,
28
28
  # in the format "projects/\\{project_number}".
29
29
  # @!attribute [rw] assessment
30
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment]
30
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment]
31
31
  # Required. The assessment details.
32
32
  class CreateAssessmentRequest
33
- include Google::Protobuf::MessageExts
34
- extend Google::Protobuf::MessageExts::ClassMethods
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
35
  end
36
36
 
37
37
  # The request message to annotate an Assessment.
38
38
  # @!attribute [rw] name
39
- # @return [String]
39
+ # @return [::String]
40
40
  # Required. The resource name of the Assessment, in the format
41
41
  # "projects/\\{project_number}/assessments/\\{assessment_id}".
42
42
  # @!attribute [rw] annotation
43
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
43
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
44
44
  # Required. The annotation that will be assigned to the Event.
45
45
  class AnnotateAssessmentRequest
46
- include Google::Protobuf::MessageExts
47
- extend Google::Protobuf::MessageExts::ClassMethods
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
48
 
49
49
  # Enum that reprensents the types of annotations.
50
50
  module Annotation
@@ -61,32 +61,32 @@ module Google
61
61
 
62
62
  # Empty response for AnnotateAssessment.
63
63
  class AnnotateAssessmentResponse
64
- include Google::Protobuf::MessageExts
65
- extend Google::Protobuf::MessageExts::ClassMethods
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
66
  end
67
67
 
68
68
  # A recaptcha assessment resource.
69
69
  # @!attribute [r] name
70
- # @return [String]
70
+ # @return [::String]
71
71
  # Output only. The resource name for the Assessment in the format
72
72
  # "projects/\\{project_number}/assessments/\\{assessment_id}".
73
73
  # @!attribute [rw] event
74
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Event]
74
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Event]
75
75
  # The event being assessed.
76
76
  # @!attribute [r] score
77
- # @return [Float]
77
+ # @return [::Float]
78
78
  # Output only. Legitimate event score from 0.0 to 1.0.
79
79
  # (1.0 means very likely legitimate traffic while 0.0 means very likely
80
80
  # non-legitimate traffic).
81
81
  # @!attribute [r] token_properties
82
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties]
82
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties]
83
83
  # Output only. Properties of the provided event token.
84
84
  # @!attribute [r] reasons
85
- # @return [Array<Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment::ClassificationReason>]
85
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment::ClassificationReason>]
86
86
  # Output only. Reasons contributing to the risk analysis verdict.
87
87
  class Assessment
88
- include Google::Protobuf::MessageExts
89
- extend Google::Protobuf::MessageExts::ClassMethods
88
+ include ::Google::Protobuf::MessageExts
89
+ extend ::Google::Protobuf::MessageExts::ClassMethods
90
90
 
91
91
  # LINT.IfChange(classification_reason)
92
92
  # Reasons contributing to the risk analysis verdict.
@@ -114,48 +114,48 @@ module Google
114
114
  end
115
115
 
116
116
  # @!attribute [rw] token
117
- # @return [String]
117
+ # @return [::String]
118
118
  # Optional. The user response token provided by the reCAPTCHA client-side integration
119
119
  # on your site.
120
120
  # @!attribute [rw] site_key
121
- # @return [String]
121
+ # @return [::String]
122
122
  # Optional. The site key that was used to invoke reCAPTCHA on your site and generate
123
123
  # the token.
124
124
  # @!attribute [rw] user_agent
125
- # @return [String]
125
+ # @return [::String]
126
126
  # Optional. The user agent present in the request from the user's device related to
127
127
  # this event.
128
128
  # @!attribute [rw] user_ip_address
129
- # @return [String]
129
+ # @return [::String]
130
130
  # Optional. The IP address in the request from the user's device related to this event.
131
131
  # @!attribute [rw] expected_action
132
- # @return [String]
132
+ # @return [::String]
133
133
  # Optional. The expected action for this type of event. This should be the same action
134
134
  # provided at token generation time on client-side platforms already
135
135
  # integrated with recaptcha enterprise.
136
136
  class Event
137
- include Google::Protobuf::MessageExts
138
- extend Google::Protobuf::MessageExts::ClassMethods
137
+ include ::Google::Protobuf::MessageExts
138
+ extend ::Google::Protobuf::MessageExts::ClassMethods
139
139
  end
140
140
 
141
141
  # @!attribute [rw] valid
142
- # @return [Boolean]
142
+ # @return [::Boolean]
143
143
  # Whether the provided user response token is valid.
144
144
  # @!attribute [rw] invalid_reason
145
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties::InvalidReason]
145
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TokenProperties::InvalidReason]
146
146
  # Reason associated with the response when valid = false.
147
147
  # @!attribute [rw] create_time
148
- # @return [Google::Protobuf::Timestamp]
148
+ # @return [::Google::Protobuf::Timestamp]
149
149
  # The timestamp corresponding to the generation of the token.
150
150
  # @!attribute [rw] hostname
151
- # @return [String]
151
+ # @return [::String]
152
152
  # The hostname of the page on which the token was generated.
153
153
  # @!attribute [rw] action
154
- # @return [String]
154
+ # @return [::String]
155
155
  # Action name provided at token generation.
156
156
  class TokenProperties
157
- include Google::Protobuf::MessageExts
158
- extend Google::Protobuf::MessageExts::ClassMethods
157
+ include ::Google::Protobuf::MessageExts
158
+ extend ::Google::Protobuf::MessageExts::ClassMethods
159
159
 
160
160
  # LINT.IfChange
161
161
  # Enum that represents the types of invalid token reasons.
@@ -188,128 +188,128 @@ module Google
188
188
 
189
189
  # The create key request message.
190
190
  # @!attribute [rw] parent
191
- # @return [String]
191
+ # @return [::String]
192
192
  # Required. The name of the project in which the key will be created, in the
193
193
  # format "projects/\\{project_number}".
194
194
  # @!attribute [rw] key
195
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
195
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
196
196
  # Required. Information to create a reCAPTCHA Enterprise key.
197
197
  class CreateKeyRequest
198
- include Google::Protobuf::MessageExts
199
- extend Google::Protobuf::MessageExts::ClassMethods
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
200
  end
201
201
 
202
202
  # The list keys request message.
203
203
  # @!attribute [rw] parent
204
- # @return [String]
204
+ # @return [::String]
205
205
  # Required. The name of the project that contains the keys that will be
206
206
  # listed, in the format "projects/\\{project_number}".
207
207
  # @!attribute [rw] page_size
208
- # @return [Integer]
208
+ # @return [::Integer]
209
209
  # Optional. The maximum number of keys to return. Default is 10. Max limit is
210
210
  # 1000.
211
211
  # @!attribute [rw] page_token
212
- # @return [String]
212
+ # @return [::String]
213
213
  # Optional. The next_page_token value returned from a previous.
214
214
  # ListKeysRequest, if any.
215
215
  class ListKeysRequest
216
- include Google::Protobuf::MessageExts
217
- extend Google::Protobuf::MessageExts::ClassMethods
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
218
  end
219
219
 
220
220
  # Response to request to list keys in a project.
221
221
  # @!attribute [rw] keys
222
- # @return [Array<Google::Cloud::RecaptchaEnterprise::V1beta1::Key>]
222
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::Key>]
223
223
  # Key details.
224
224
  # @!attribute [rw] next_page_token
225
- # @return [String]
225
+ # @return [::String]
226
226
  # Token to retrieve the next page of results. It is set to empty if no keys
227
227
  # remain in results.
228
228
  class ListKeysResponse
229
- include Google::Protobuf::MessageExts
230
- extend Google::Protobuf::MessageExts::ClassMethods
229
+ include ::Google::Protobuf::MessageExts
230
+ extend ::Google::Protobuf::MessageExts::ClassMethods
231
231
  end
232
232
 
233
233
  # The get key request message.
234
234
  # @!attribute [rw] name
235
- # @return [String]
235
+ # @return [::String]
236
236
  # Required. The name of the requested key, in the format
237
237
  # "projects/\\{project_number}/keys/\\{key_id}".
238
238
  class GetKeyRequest
239
- include Google::Protobuf::MessageExts
240
- extend Google::Protobuf::MessageExts::ClassMethods
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
241
  end
242
242
 
243
243
  # The update key request message.
244
244
  # @!attribute [rw] key
245
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
245
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Key]
246
246
  # Required. The key to update.
247
247
  # @!attribute [rw] update_mask
248
- # @return [Google::Protobuf::FieldMask]
248
+ # @return [::Google::Protobuf::FieldMask]
249
249
  # Optional. The mask to control which field of the key get updated. If the mask is not
250
250
  # present, all fields will be updated.
251
251
  class UpdateKeyRequest
252
- include Google::Protobuf::MessageExts
253
- extend Google::Protobuf::MessageExts::ClassMethods
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
254
  end
255
255
 
256
256
  # The delete key request message.
257
257
  # @!attribute [rw] name
258
- # @return [String]
258
+ # @return [::String]
259
259
  # Required. The name of the key to be deleted, in the format
260
260
  # "projects/\\{project_number}/keys/\\{key_id}".
261
261
  class DeleteKeyRequest
262
- include Google::Protobuf::MessageExts
263
- extend Google::Protobuf::MessageExts::ClassMethods
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
264
  end
265
265
 
266
266
  # A key used to identify and configure applications (web and/or mobile) that
267
267
  # use reCAPTCHA Enterprise.
268
268
  # @!attribute [rw] name
269
- # @return [String]
269
+ # @return [::String]
270
270
  # The resource name for the Key in the format
271
271
  # "projects/\\{project_number}/keys/\\{key_id}".
272
272
  # @!attribute [rw] display_name
273
- # @return [String]
273
+ # @return [::String]
274
274
  # Human-readable display name of this key. Modifiable by user.
275
275
  # @!attribute [rw] web_settings
276
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings]
276
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings]
277
277
  # Settings for keys that can be used by websites.
278
278
  # @!attribute [rw] android_settings
279
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::AndroidKeySettings]
279
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AndroidKeySettings]
280
280
  # Settings for keys that can be used by Android apps.
281
281
  # @!attribute [rw] ios_settings
282
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::IOSKeySettings]
282
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::IOSKeySettings]
283
283
  # Settings for keys that can be used by iOS apps.
284
284
  class Key
285
- include Google::Protobuf::MessageExts
286
- extend Google::Protobuf::MessageExts::ClassMethods
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
287
  end
288
288
 
289
289
  # Settings specific to keys that can be used by websites.
290
290
  # @!attribute [rw] enforce_allowed_domains
291
- # @return [Boolean]
291
+ # @return [::Boolean]
292
292
  # Whether allowed_domains is enforced or not.
293
293
  # @!attribute [rw] allowed_domains
294
- # @return [Array<String>]
294
+ # @return [::Array<::String>]
295
295
  # Domains or subdomains of websites allowed to use the key. All subdomains
296
296
  # of an allowed domain are automatically allowed. A valid domain requires a
297
297
  # host and must not include any path, port, query or fragment.
298
298
  # Examples: 'example.com' or 'subdomain.example.com'
299
299
  # @!attribute [rw] allow_amp_traffic
300
- # @return [Boolean]
300
+ # @return [::Boolean]
301
301
  # Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
302
302
  # @!attribute [rw] integration_type
303
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType]
303
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::IntegrationType]
304
304
  # Required. Describes how this key is integrated with the website.
305
305
  # @!attribute [rw] challenge_security_preference
306
- # @return [Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference]
306
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::WebKeySettings::ChallengeSecurityPreference]
307
307
  # Settings for the frequency and difficulty at which this key triggers
308
308
  # captcha challenges. This should only be specified for IntegrationTypes
309
309
  # CHECKBOX_CHALLENGE and INVISIBLE_CHALLENGE.
310
310
  class WebKeySettings
311
- include Google::Protobuf::MessageExts
312
- extend Google::Protobuf::MessageExts::ClassMethods
311
+ include ::Google::Protobuf::MessageExts
312
+ extend ::Google::Protobuf::MessageExts::ClassMethods
313
313
 
314
314
  # Enum that represents the integration types for web keys.
315
315
  module IntegrationType
@@ -350,22 +350,22 @@ module Google
350
350
 
351
351
  # Settings specific to keys that can be used by Android apps.
352
352
  # @!attribute [rw] allowed_package_names
353
- # @return [Array<String>]
353
+ # @return [::Array<::String>]
354
354
  # Android package names of apps allowed to use the key.
355
355
  # Example: 'com.companyname.appname'
356
356
  class AndroidKeySettings
357
- include Google::Protobuf::MessageExts
358
- extend Google::Protobuf::MessageExts::ClassMethods
357
+ include ::Google::Protobuf::MessageExts
358
+ extend ::Google::Protobuf::MessageExts::ClassMethods
359
359
  end
360
360
 
361
361
  # Settings specific to keys that can be used by iOS apps.
362
362
  # @!attribute [rw] allowed_bundle_ids
363
- # @return [Array<String>]
363
+ # @return [::Array<::String>]
364
364
  # iOS bundle ids of apps allowed to use the key.
365
365
  # Example: 'com.companyname.productname.appname'
366
366
  class IOSKeySettings
367
- include Google::Protobuf::MessageExts
368
- extend Google::Protobuf::MessageExts::ClassMethods
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
369
  end
370
370
  end
371
371
  end