Google Cloud Recaptcha Enterprise V1 Client - Class RecaptchaEnterpriseServiceClient (1.16.1)

Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class RecaptchaEnterpriseServiceClient.

Service Description: Service to determine the likelihood an event is legitimate.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array

Optional. Options for configuring the service API wrapper.
↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "
↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.
↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

addIpOverride

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.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::addIpOverrideAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideRequest;
use Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData;
use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData\OverrideType;

/**
 * @param string $formattedName              The name of the key to which the IP override is added, in the
 *                                           format `projects/{project}/keys/{key}`. Please see
 *                                           {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 * @param string $ipOverrideDataIp           The IP address to override (can be IPv4, IPv6 or CIDR).
 *                                           The IP override must be a valid IPv4 or IPv6 address, or a CIDR range.
 *                                           The IP override must be a public IP address.
 *                                           Example of IPv4: 168.192.5.6
 *                                           Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B
 *                                           Example of IPv4 with CIDR: 168.192.5.0/24
 *                                           Example of IPv6 with CIDR: 2001:0DB8:1234::/48
 * @param int    $ipOverrideDataOverrideType Describes the type of IP override.
 */
function add_ip_override_sample(
    string $formattedName,
    string $ipOverrideDataIp,
    int $ipOverrideDataOverrideType
): void {
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $ipOverrideData = (new IpOverrideData())
        ->setIp($ipOverrideDataIp)
        ->setOverrideType($ipOverrideDataOverrideType);
    $request = (new AddIpOverrideRequest())
        ->setName($formattedName)
        ->setIpOverrideData($ipOverrideData);

    // Call the API and handle any network failures.
    try {
        /** @var AddIpOverrideResponse $response */
        $response = $recaptchaEnterpriseServiceClient->addIpOverride($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');
    $ipOverrideDataIp = '[IP]';
    $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED;

    add_ip_override_sample($formattedName, $ipOverrideDataIp, $ipOverrideDataOverrideType);
}

annotateAssessment

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

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::annotateAssessmentAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest;
use Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation;
use Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;

/**
 * @param string $formattedName The resource name of the Assessment, in the format
 *                              `projects/{project}/assessments/{assessment}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::assessmentName()} for help formatting this field.
 * @param int    $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.
 */
function annotate_assessment_sample(string $formattedName, int $annotation): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new AnnotateAssessmentRequest())
        ->setName($formattedName)
        ->setAnnotation($annotation);

    // Call the API and handle any network failures.
    try {
        /** @var AnnotateAssessmentResponse $response */
        $response = $recaptchaEnterpriseServiceClient->annotateAssessment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::assessmentName('[PROJECT]', '[ASSESSMENT]');
    $annotation = Annotation::ANNOTATION_UNSPECIFIED;

    annotate_assessment_sample($formattedName, $annotation);
}

createAssessment

Creates an Assessment of the likelihood an event is legitimate.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::createAssessmentAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Assessment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Assessment;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest;

/**
 * @param string $formattedParent The name of the project in which the assessment is created,
 *                                in the format `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function create_assessment_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $assessment = new Assessment();
    $request = (new CreateAssessmentRequest())
        ->setParent($formattedParent)
        ->setAssessment($assessment);

    // Call the API and handle any network failures.
    try {
        /** @var Assessment $response */
        $response = $recaptchaEnterpriseServiceClient->createAssessment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    create_assessment_sample($formattedParent);
}

createFirewallPolicy

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

A project may have a maximum of 1000 policies.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::createFirewallPolicyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateFirewallPolicyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\CreateFirewallPolicyRequest;
use Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy;

/**
 * @param string $formattedParent The name of the project this policy applies to, in the format
 *                                `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function create_firewall_policy_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $firewallPolicy = new FirewallPolicy();
    $request = (new CreateFirewallPolicyRequest())
        ->setParent($formattedParent)
        ->setFirewallPolicy($firewallPolicy);

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicy $response */
        $response = $recaptchaEnterpriseServiceClient->createFirewallPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    create_firewall_policy_sample($formattedParent);
}

createKey

Creates a new reCAPTCHA Enterprise key.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::createKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Key
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest;
use Google\Cloud\RecaptchaEnterprise\V1\Key;

/**
 * @param string $formattedParent The name of the project in which the key is created, in the
 *                                format `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 * @param string $keyDisplayName  Human-readable display name of this key. Modifiable by user.
 */
function create_key_sample(string $formattedParent, string $keyDisplayName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $key = (new Key())
        ->setDisplayName($keyDisplayName);
    $request = (new CreateKeyRequest())
        ->setParent($formattedParent)
        ->setKey($key);

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $recaptchaEnterpriseServiceClient->createKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');
    $keyDisplayName = '[DISPLAY_NAME]';

    create_key_sample($formattedParent, $keyDisplayName);
}

deleteFirewallPolicy

Deletes the specified firewall policy.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::deleteFirewallPolicyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\DeleteFirewallPolicyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\DeleteFirewallPolicyRequest;

/**
 * @param string $formattedName The name of the policy to be deleted, in the format
 *                              `projects/{project}/firewallpolicies/{firewallpolicy}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::firewallPolicyName()} for help formatting this field.
 */
function delete_firewall_policy_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new DeleteFirewallPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $recaptchaEnterpriseServiceClient->deleteFirewallPolicy($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::firewallPolicyName(
        '[PROJECT]',
        '[FIREWALLPOLICY]'
    );

    delete_firewall_policy_sample($formattedName);
}

deleteKey

Deletes the specified key.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::deleteKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\DeleteKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\DeleteKeyRequest;

/**
 * @param string $formattedName The name of the key to be deleted, in the format
 *                              `projects/{project}/keys/{key}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 */
function delete_key_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new DeleteKeyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $recaptchaEnterpriseServiceClient->deleteKey($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');

    delete_key_sample($formattedName);
}

getFirewallPolicy

Returns the specified firewall policy.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::getFirewallPolicyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetFirewallPolicyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy;
use Google\Cloud\RecaptchaEnterprise\V1\GetFirewallPolicyRequest;

/**
 * @param string $formattedName The name of the requested policy, in the format
 *                              `projects/{project}/firewallpolicies/{firewallpolicy}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::firewallPolicyName()} for help formatting this field.
 */
function get_firewall_policy_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new GetFirewallPolicyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicy $response */
        $response = $recaptchaEnterpriseServiceClient->getFirewallPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::firewallPolicyName(
        '[PROJECT]',
        '[FIREWALLPOLICY]'
    );

    get_firewall_policy_sample($formattedName);
}

getKey

Returns the specified key.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::getKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Key
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\GetKeyRequest;
use Google\Cloud\RecaptchaEnterprise\V1\Key;

/**
 * @param string $formattedName The name of the requested key, in the format
 *                              `projects/{project}/keys/{key}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 */
function get_key_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new GetKeyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $recaptchaEnterpriseServiceClient->getKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');

    get_key_sample($formattedName);
}

getMetrics

Get some aggregated metrics for a Key. This data can be used to build dashboards.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::getMetricsAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Metrics
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest;
use Google\Cloud\RecaptchaEnterprise\V1\Metrics;

/**
 * @param string $formattedName The name of the requested metrics, in the format
 *                              `projects/{project}/keys/{key}/metrics`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::metricsName()} for help formatting this field.
 */
function get_metrics_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new GetMetricsRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Metrics $response */
        $response = $recaptchaEnterpriseServiceClient->getMetrics($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::metricsName('[PROJECT]', '[KEY]');

    get_metrics_sample($formattedName);
}

listFirewallPolicies

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

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::listFirewallPoliciesAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy;
use Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest;

/**
 * @param string $formattedParent The name of the project to list the policies for, in the format
 *                                `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function list_firewall_policies_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new ListFirewallPoliciesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->listFirewallPolicies($request);

        /** @var FirewallPolicy $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    list_firewall_policies_sample($formattedParent);
}

listIpOverrides

Lists all IP overrides for a key.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::listIpOverridesAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData;
use Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest;

/**
 * @param string $formattedParent The parent key for which the IP overrides are listed, in the
 *                                format `projects/{project}/keys/{key}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 */
function list_ip_overrides_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new ListIpOverridesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->listIpOverrides($request);

        /** @var IpOverrideData $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');

    list_ip_overrides_sample($formattedParent);
}

listKeys

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

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::listKeysAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\Key;
use Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest;

/**
 * @param string $formattedParent The name of the project that contains the keys that is
 *                                listed, in the format `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function list_keys_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new ListKeysRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->listKeys($request);

        /** @var Key $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    list_keys_sample($formattedParent);
}

listRelatedAccountGroupMemberships

Get memberships in a group of related accounts.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::listRelatedAccountGroupMembershipsAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest;
use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroupMembership;

/**
 * @param string $formattedParent The resource name for the related account group in the format
 *                                `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::relatedAccountGroupName()} for help formatting this field.
 */
function list_related_account_group_memberships_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new ListRelatedAccountGroupMembershipsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->listRelatedAccountGroupMemberships($request);

        /** @var RelatedAccountGroupMembership $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::relatedAccountGroupName(
        '[PROJECT]',
        '[RELATEDACCOUNTGROUP]'
    );

    list_related_account_group_memberships_sample($formattedParent);
}

listRelatedAccountGroups

List groups of related accounts.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::listRelatedAccountGroupsAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest;
use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroup;

/**
 * @param string $formattedParent The name of the project to list related account groups from, in
 *                                the format `projects/{project}`. Please see
 *                                {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function list_related_account_groups_sample(string $formattedParent): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new ListRelatedAccountGroupsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->listRelatedAccountGroups($request);

        /** @var RelatedAccountGroup $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    list_related_account_groups_sample($formattedParent);
}

migrateKey

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.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::migrateKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Key
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\Key;
use Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest;

/**
 * @param string $formattedName The name of the key to be migrated, in the format
 *                              `projects/{project}/keys/{key}`. Please see
 *                              {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 */
function migrate_key_sample(string $formattedName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new MigrateKeyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $recaptchaEnterpriseServiceClient->migrateKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');

    migrate_key_sample($formattedName);
}

removeIpOverride

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.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::removeIpOverrideAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData;
use Google\Cloud\RecaptchaEnterprise\V1\IpOverrideData\OverrideType;
use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest;
use Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse;

/**
 * @param string $formattedName              The name of the key from which the IP override is removed, in the
 *                                           format `projects/{project}/keys/{key}`. Please see
 *                                           {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 * @param string $ipOverrideDataIp           The IP address to override (can be IPv4, IPv6 or CIDR).
 *                                           The IP override must be a valid IPv4 or IPv6 address, or a CIDR range.
 *                                           The IP override must be a public IP address.
 *                                           Example of IPv4: 168.192.5.6
 *                                           Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B
 *                                           Example of IPv4 with CIDR: 168.192.5.0/24
 *                                           Example of IPv6 with CIDR: 2001:0DB8:1234::/48
 * @param int    $ipOverrideDataOverrideType Describes the type of IP override.
 */
function remove_ip_override_sample(
    string $formattedName,
    string $ipOverrideDataIp,
    int $ipOverrideDataOverrideType
): void {
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $ipOverrideData = (new IpOverrideData())
        ->setIp($ipOverrideDataIp)
        ->setOverrideType($ipOverrideDataOverrideType);
    $request = (new RemoveIpOverrideRequest())
        ->setName($formattedName)
        ->setIpOverrideData($ipOverrideData);

    // Call the API and handle any network failures.
    try {
        /** @var RemoveIpOverrideResponse $response */
        $response = $recaptchaEnterpriseServiceClient->removeIpOverride($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');
    $ipOverrideDataIp = '[IP]';
    $ipOverrideDataOverrideType = OverrideType::OVERRIDE_TYPE_UNSPECIFIED;

    remove_ip_override_sample($formattedName, $ipOverrideDataIp, $ipOverrideDataOverrideType);
}

reorderFirewallPolicies

Reorders all firewall policies.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::reorderFirewallPoliciesAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest;
use Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse;

/**
 * @param string $formattedParent       The name of the project to list the policies for, in the format
 *                                      `projects/{project}`. Please see
 *                                      {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 * @param string $formattedNamesElement A list containing all policy names, in the new order. Each name
 *                                      is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. Please see
 *                                      {@see RecaptchaEnterpriseServiceClient::firewallPolicyName()} for help formatting this field.
 */
function reorder_firewall_policies_sample(
    string $formattedParent,
    string $formattedNamesElement
): void {
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $formattedNames = [$formattedNamesElement,];
    $request = (new ReorderFirewallPoliciesRequest())
        ->setParent($formattedParent)
        ->setNames($formattedNames);

    // Call the API and handle any network failures.
    try {
        /** @var ReorderFirewallPoliciesResponse $response */
        $response = $recaptchaEnterpriseServiceClient->reorderFirewallPolicies($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');
    $formattedNamesElement = RecaptchaEnterpriseServiceClient::firewallPolicyName(
        '[PROJECT]',
        '[FIREWALLPOLICY]'
    );

    reorder_firewall_policies_sample($formattedParent, $formattedNamesElement);
}

retrieveLegacySecretKey

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.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::retrieveLegacySecretKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest;
use Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse;

/**
 * @param string $formattedKey The public key name linked to the requested secret key in the
 *                             format `projects/{project}/keys/{key}`. Please see
 *                             {@see RecaptchaEnterpriseServiceClient::keyName()} for help formatting this field.
 */
function retrieve_legacy_secret_key_sample(string $formattedKey): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new RetrieveLegacySecretKeyRequest())
        ->setKey($formattedKey);

    // Call the API and handle any network failures.
    try {
        /** @var RetrieveLegacySecretKeyResponse $response */
        $response = $recaptchaEnterpriseServiceClient->retrieveLegacySecretKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedKey = RecaptchaEnterpriseServiceClient::keyName('[PROJECT]', '[KEY]');

    retrieve_legacy_secret_key_sample($formattedKey);
}

searchRelatedAccountGroupMemberships

Search group memberships related to a given account.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::searchRelatedAccountGroupMembershipsAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\RelatedAccountGroupMembership;
use Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest;

/**
 * @param string $formattedProject The name of the project to search related account group
 *                                 memberships from. Specify the project name in the following format:
 *                                 `projects/{project}`. Please see
 *                                 {@see RecaptchaEnterpriseServiceClient::projectName()} for help formatting this field.
 */
function search_related_account_group_memberships_sample(string $formattedProject): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $request = (new SearchRelatedAccountGroupMembershipsRequest())
        ->setProject($formattedProject);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $recaptchaEnterpriseServiceClient->searchRelatedAccountGroupMemberships($request);

        /** @var RelatedAccountGroupMembership $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedProject = RecaptchaEnterpriseServiceClient::projectName('[PROJECT]');

    search_related_account_group_memberships_sample($formattedProject);
}

updateFirewallPolicy

Updates the specified firewall policy.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::updateFirewallPolicyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\UpdateFirewallPolicyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy;
use Google\Cloud\RecaptchaEnterprise\V1\UpdateFirewallPolicyRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_firewall_policy_sample(): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $firewallPolicy = new FirewallPolicy();
    $request = (new UpdateFirewallPolicyRequest())
        ->setFirewallPolicy($firewallPolicy);

    // Call the API and handle any network failures.
    try {
        /** @var FirewallPolicy $response */
        $response = $recaptchaEnterpriseServiceClient->updateFirewallPolicy($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateKey

Updates the specified key.

The async variant is Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::updateKeyAsync() .

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\UpdateKeyRequest

A request to house fields associated with the call.
callOptions array

Optional.
↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
Returns
Type Description
Google\Cloud\RecaptchaEnterprise\V1\Key
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient;
use Google\Cloud\RecaptchaEnterprise\V1\Key;
use Google\Cloud\RecaptchaEnterprise\V1\UpdateKeyRequest;

/**
 * @param string $keyDisplayName Human-readable display name of this key. Modifiable by user.
 */
function update_key_sample(string $keyDisplayName): void
{
    // Create a client.
    $recaptchaEnterpriseServiceClient = new RecaptchaEnterpriseServiceClient();

    // Prepare the request message.
    $key = (new Key())
        ->setDisplayName($keyDisplayName);
    $request = (new UpdateKeyRequest())
        ->setKey($key);

    // Call the API and handle any network failures.
    try {
        /** @var Key $response */
        $response = $recaptchaEnterpriseServiceClient->updateKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $keyDisplayName = '[DISPLAY_NAME]';

    update_key_sample($keyDisplayName);
}

addIpOverrideAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideResponse>

annotateAssessmentAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentResponse>

createAssessmentAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Assessment>

createFirewallPolicyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateFirewallPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy>

createKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Key>

deleteFirewallPolicyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\DeleteFirewallPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

deleteKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\DeleteKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

getFirewallPolicyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetFirewallPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy>

getKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Key>

getMetricsAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Metrics>

listFirewallPoliciesAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listIpOverridesAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listKeysAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listRelatedAccountGroupMembershipsAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listRelatedAccountGroupsAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

migrateKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Key>

removeIpOverrideAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse>

reorderFirewallPoliciesAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse>

retrieveLegacySecretKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse>

searchRelatedAccountGroupMembershipsAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateFirewallPolicyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\UpdateFirewallPolicyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy>

updateKeyAsync

Parameters
Name Description
request Google\Cloud\RecaptchaEnterprise\V1\UpdateKeyRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\RecaptchaEnterprise\V1\Key>

static::assessmentName

Formats a string containing the fully-qualified path to represent a assessment resource.

Parameters
Name Description
project string
assessment string
Returns
Type Description
string The formatted assessment resource.

static::firewallPolicyName

Formats a string containing the fully-qualified path to represent a firewall_policy resource.

Parameters
Name Description
project string
firewallpolicy string
Returns
Type Description
string The formatted firewall_policy resource.

static::keyName

Formats a string containing the fully-qualified path to represent a key resource.

Parameters
Name Description
project string
key string
Returns
Type Description
string The formatted key resource.

static::metricsName

Formats a string containing the fully-qualified path to represent a metrics resource.

Parameters
Name Description
project string
key string
Returns
Type Description
string The formatted metrics resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name Description
project string
Returns
Type Description
string The formatted project resource.

static::relatedAccountGroupName

Formats a string containing the fully-qualified path to represent a related_account_group resource.

Parameters
Name Description
project string
relatedaccountgroup string
Returns
Type Description
string The formatted related_account_group resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • assessment: projects/{project}/assessments/{assessment}
  • firewallPolicy: projects/{project}/firewallpolicies/{firewallpolicy}
  • key: projects/{project}/keys/{key}
  • metrics: projects/{project}/keys/{key}/metrics
  • project: projects/{project}
  • relatedAccountGroup: projects/{project}/relatedaccountgroups/{relatedaccountgroup}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string
template string

Optional name of template to match
Returns
Type Description
array An associative array from name component IDs to component values.