Class RecaptchaEnterpriseServiceClient (2.31.0)

Required. The name of the project in which the assessment is created, in the format projects/{project}.

Required. The assessment details.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Assessment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Assessment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project in which the key is created, in the format projects/{project}.

Required. Information to create a reCAPTCHA Enterprise key.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.CreateKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project that contains the keys that is listed, in the format projects/{project}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.Key, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ListKeysRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.Key, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the requested key, in the format projects/{project}/keys/{key}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.GetKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The key to update.

Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.UpdateKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.DeleteKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.MigrateKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Key) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the key to which the IP override is added, in the format projects/{project}/keys/{key}.

Required. IP override added to the key.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.AddIpOverrideResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.AddIpOverrideRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.AddIpOverrideResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the key from which the IP override is removed, in the format projects/{project}/keys/{key}.

Required. IP override to be removed from the key.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.RemoveIpOverrideResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.RemoveIpOverrideRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.RemoveIpOverrideResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.IpOverrideData, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ListIpOverridesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.IpOverrideData, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The name of the requested metrics, in the format projects/{project}/keys/{key}/metrics.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Metrics) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.GetMetricsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.Metrics) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project this policy applies to, in the format projects/{project}.

Required. Information to create the policy.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.CreateFirewallPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project to list the policies for, in the format projects/{project}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.FirewallPolicy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.FirewallPolicy, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The name of the requested policy, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.GetFirewallPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The policy to update.

Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.UpdateFirewallPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.FirewallPolicy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the policy to be deleted, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.DeleteFirewallPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a Status object. If the request failed, the status contains the details of the failure.

Required. The name of the project to list the policies for, in the format projects/{project}.

Required. A list containing all policy names, in the new order. Each name is in the format projects/{project}/firewallpolicies/{firewallpolicy}.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

the result of the RPC. The response message type (google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Required. The name of the project to list related account groups from, in the format projects/{project}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

Optional. Deprecated: use account_id instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a hashed_account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

Optional. Override the class-level options, such as retry and backoff policies.

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.