Class RecaptchaEnterpriseServiceClient (2.31.0-rc)

Service to determine the likelihood an event is legitimate.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

RecaptchaEnterpriseServiceClient(RecaptchaEnterpriseServiceClient const &)

Copy and move support

Parameter
Name	Description
	`RecaptchaEnterpriseServiceClient const &`

RecaptchaEnterpriseServiceClient(RecaptchaEnterpriseServiceClient &&)

Copy and move support

Parameter
Name	Description
	`RecaptchaEnterpriseServiceClient &&`

RecaptchaEnterpriseServiceClient(std::shared_ptr< RecaptchaEnterpriseServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< RecaptchaEnterpriseServiceConnection >`
`opts`	`Options`

Operators

operator=(RecaptchaEnterpriseServiceClient const &)

Copy and move support

Parameter
Name	Description
	`RecaptchaEnterpriseServiceClient const &`

Returns
Type	Description
`RecaptchaEnterpriseServiceClient &`

operator=(RecaptchaEnterpriseServiceClient &&)

Copy and move support

Parameter
Name	Description
	`RecaptchaEnterpriseServiceClient &&`

Returns
Type	Description
`RecaptchaEnterpriseServiceClient &`

Functions

CreateAssessment(std::string const &, google::cloud::recaptchaenterprise::v1::Assessment const &, Options)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project in which the assessment is created, in the format `projects/{project}`.
`assessment`	`google::cloud::recaptchaenterprise::v1::Assessment const &` Required. The assessment details.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Assessment >`	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.

CreateAssessment(google::cloud::recaptchaenterprise::v1::CreateAssessmentRequest const &, Options)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::CreateAssessmentRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Assessment >`	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.

AnnotateAssessment(std::string const &, google::cloud::recaptchaenterprise::v1::AnnotateAssessmentRequest::Annotation, Options)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Assessment, in the format `projects/{project}/assessments/{assessment}`.
`annotation`	`google::cloud::recaptchaenterprise::v1::AnnotateAssessmentRequest::Annotation` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::AnnotateAssessmentResponse >`	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.

AnnotateAssessment(google::cloud::recaptchaenterprise::v1::AnnotateAssessmentRequest const &, Options)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::AnnotateAssessmentRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::AnnotateAssessmentResponse >`	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.

CreateKey(std::string const &, google::cloud::recaptchaenterprise::v1::Key const &, Options)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project in which the key is created, in the format `projects/{project}`.
`key`	`google::cloud::recaptchaenterprise::v1::Key const &` Required. Information to create a reCAPTCHA Enterprise key.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

CreateKey(google::cloud::recaptchaenterprise::v1::CreateKeyRequest const &, Options)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::CreateKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

ListKeys(std::string const &, Options)

Returns the list of all keys that belong to a project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project that contains the keys that is listed, in the format `projects/{project}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::Key >

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.

ListKeys(google::cloud::recaptchaenterprise::v1::ListKeysRequest, Options)

Returns the list of all keys that belong to a project.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ListKeysRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::Key >

RetrieveLegacySecretKey(std::string const &, Options)

Returns the secret key related to the specified public key.

You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name	Description
`key`	`std::string const &` Required. The public key name linked to the requested secret key in the format `projects/{project}/keys/{key}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::RetrieveLegacySecretKeyResponse >`	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.

RetrieveLegacySecretKey(google::cloud::recaptchaenterprise::v1::RetrieveLegacySecretKeyRequest const &, Options)

Returns the secret key related to the specified public key.

You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::RetrieveLegacySecretKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::RetrieveLegacySecretKeyResponse >`	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.

GetKey(std::string const &, Options)

Returns the specified key.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the requested key, in the format `projects/{project}/keys/{key}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

GetKey(google::cloud::recaptchaenterprise::v1::GetKeyRequest const &, Options)

Returns the specified key.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::GetKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

UpdateKey(google::cloud::recaptchaenterprise::v1::Key const &, google::protobuf::FieldMask const &, Options)

Updates the specified key.

Parameters
Name	Description
`key`	`google::cloud::recaptchaenterprise::v1::Key const &` Required. The key to update.
`update_mask`	`google::protobuf::FieldMask const &` Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

UpdateKey(google::cloud::recaptchaenterprise::v1::UpdateKeyRequest const &, Options)

Updates the specified key.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::UpdateKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

DeleteKey(std::string const &, Options)

Deletes the specified key.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the key to be deleted, in the format `projects/{project}/keys/{key}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteKey(google::cloud::recaptchaenterprise::v1::DeleteKeyRequest const &, Options)

Deletes the specified key.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::DeleteKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

MigrateKey(google::cloud::recaptchaenterprise::v1::MigrateKeyRequest const &, Options)

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.

Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::MigrateKeyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Key >`	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.

AddIpOverride(std::string const &, google::cloud::recaptchaenterprise::v1::IpOverrideData const &, Options)

Adds an IP override to a key.

The following restrictions hold:

The maximum number of IP overrides per key is 100.
For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`.
`ip_override_data`	`google::cloud::recaptchaenterprise::v1::IpOverrideData const &` Required. IP override added to the key.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::AddIpOverrideResponse >`	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.

AddIpOverride(google::cloud::recaptchaenterprise::v1::AddIpOverrideRequest const &, Options)

Adds an IP override to a key.

The following restrictions hold:

The maximum number of IP overrides per key is 100.
For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::AddIpOverrideRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::AddIpOverrideResponse >`	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.

RemoveIpOverride(std::string const &, google::cloud::recaptchaenterprise::v1::IpOverrideData const &, Options)

Removes an IP override from a key.

The following restrictions hold:

If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the key from which the IP override is removed, in the format `projects/{project}/keys/{key}`.
`ip_override_data`	`google::cloud::recaptchaenterprise::v1::IpOverrideData const &` Required. IP override to be removed from the key.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::RemoveIpOverrideResponse >`	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.

RemoveIpOverride(google::cloud::recaptchaenterprise::v1::RemoveIpOverrideRequest const &, Options)

Removes an IP override from a key.

The following restrictions hold:

If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::RemoveIpOverrideRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::RemoveIpOverrideResponse >`	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.

ListIpOverrides(std::string const &, Options)

Lists all IP overrides for a key.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent key for which the IP overrides are listed, in the format `projects/{project}/keys/{key}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::IpOverrideData >

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.

ListIpOverrides(google::cloud::recaptchaenterprise::v1::ListIpOverridesRequest, Options)

Lists all IP overrides for a key.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ListIpOverridesRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::IpOverrideData >

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.

GetMetrics(std::string const &, Options)

Get some aggregated metrics for a Key.

This data can be used to build dashboards.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the requested metrics, in the format `projects/{project}/keys/{key}/metrics`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Metrics >`	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.

GetMetrics(google::cloud::recaptchaenterprise::v1::GetMetricsRequest const &, Options)

Get some aggregated metrics for a Key.

This data can be used to build dashboards.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::GetMetricsRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::Metrics >`	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.

CreateFirewallPolicy(std::string const &, google::cloud::recaptchaenterprise::v1::FirewallPolicy const &, Options)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed.

A project may have a maximum of 1000 policies.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project this policy applies to, in the format `projects/{project}`.
`firewall_policy`	`google::cloud::recaptchaenterprise::v1::FirewallPolicy const &` Required. Information to create the policy.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

CreateFirewallPolicy(google::cloud::recaptchaenterprise::v1::CreateFirewallPolicyRequest const &, Options)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed.

A project may have a maximum of 1000 policies.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::CreateFirewallPolicyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

ListFirewallPolicies(std::string const &, Options)

Returns the list of all firewall policies that belong to a project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project to list the policies for, in the format `projects/{project}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::FirewallPolicy >

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.

ListFirewallPolicies(google::cloud::recaptchaenterprise::v1::ListFirewallPoliciesRequest, Options)

Returns the list of all firewall policies that belong to a project.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ListFirewallPoliciesRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::FirewallPolicy >

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.

GetFirewallPolicy(std::string const &, Options)

Returns the specified firewall policy.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the requested policy, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

GetFirewallPolicy(google::cloud::recaptchaenterprise::v1::GetFirewallPolicyRequest const &, Options)

Returns the specified firewall policy.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::GetFirewallPolicyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

UpdateFirewallPolicy(google::cloud::recaptchaenterprise::v1::FirewallPolicy const &, google::protobuf::FieldMask const &, Options)

Updates the specified firewall policy.

Parameters
Name	Description
`firewall_policy`	`google::cloud::recaptchaenterprise::v1::FirewallPolicy const &` Required. The policy to update.
`update_mask`	`google::protobuf::FieldMask const &` Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

UpdateFirewallPolicy(google::cloud::recaptchaenterprise::v1::UpdateFirewallPolicyRequest const &, Options)

Updates the specified firewall policy.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::UpdateFirewallPolicyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::FirewallPolicy >`	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.

DeleteFirewallPolicy(std::string const &, Options)

Deletes the specified firewall policy.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the policy to be deleted, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteFirewallPolicy(google::cloud::recaptchaenterprise::v1::DeleteFirewallPolicyRequest const &, Options)

Deletes the specified firewall policy.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::DeleteFirewallPolicyRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ReorderFirewallPolicies(std::string const &, std::vector< std::string > const &, Options)

Reorders all firewall policies.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project to list the policies for, in the format `projects/{project}`.
`names`	`std::vector< std::string > const &` Required. A list containing all policy names, in the new order. Each name is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::ReorderFirewallPoliciesResponse >`	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.

ReorderFirewallPolicies(google::cloud::recaptchaenterprise::v1::ReorderFirewallPoliciesRequest const &, Options)

Reorders all firewall policies.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ReorderFirewallPoliciesRequest const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::recaptchaenterprise::v1::ReorderFirewallPoliciesResponse >`	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.

ListRelatedAccountGroups(std::string const &, Options)

List groups of related accounts.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project to list related account groups from, in the format `projects/{project}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroup >

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.

ListRelatedAccountGroups(google::cloud::recaptchaenterprise::v1::ListRelatedAccountGroupsRequest, Options)

List groups of related accounts.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ListRelatedAccountGroupsRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroup >

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.

ListRelatedAccountGroupMemberships(std::string const &, Options)

Get memberships in a group of related accounts.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name for the related account group in the format `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroupMembership >

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.

ListRelatedAccountGroupMemberships(google::cloud::recaptchaenterprise::v1::ListRelatedAccountGroupMembershipsRequest, Options)

Get memberships in a group of related accounts.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::ListRelatedAccountGroupMembershipsRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroupMembership >

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.

SearchRelatedAccountGroupMemberships(std::string const &, std::string const &, Options)

Search group memberships related to a given account.

Parameters
Name	Description
`project`	`std::string const &` Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`.
`hashed_account_id`	`std::string const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroupMembership >

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.

SearchRelatedAccountGroupMemberships(google::cloud::recaptchaenterprise::v1::SearchRelatedAccountGroupMembershipsRequest, Options)

Search group memberships related to a given account.

Parameters
Name	Description
`request`	`google::cloud::recaptchaenterprise::v1::SearchRelatedAccountGroupMembershipsRequest` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::recaptchaenterprise::v1::RelatedAccountGroupMembership >

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.