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

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.

This class is currently experimental and may be subject to changes. See Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient for the stable implementation

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
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.

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
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentResponse

createAssessment

Creates an Assessment of the likelihood an event is legitimate.

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

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Assessment

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
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

createKey

Creates a new reCAPTCHA Enterprise key.

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

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Key

deleteFirewallPolicy

Parameters
NameDescription
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.

deleteKey

Parameters
NameDescription
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.

getFirewallPolicy

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

getKey

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Key

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
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Metrics

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
NameDescription
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
TypeDescription
Google\ApiCore\PagedListResponse

listKeys

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

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

Parameters
NameDescription
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
TypeDescription
Google\ApiCore\PagedListResponse

listRelatedAccountGroupMemberships

Parameters
NameDescription
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
TypeDescription
Google\ApiCore\PagedListResponse

listRelatedAccountGroups

Parameters
NameDescription
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
TypeDescription
Google\ApiCore\PagedListResponse

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
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Key

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
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse

searchRelatedAccountGroupMemberships

Parameters
NameDescription
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
TypeDescription
Google\ApiCore\PagedListResponse

updateFirewallPolicy

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

updateKey

Parameters
NameDescription
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
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\Key

annotateAssessmentAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createAssessmentAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createFirewallPolicyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\CreateFirewallPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

createKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteFirewallPolicyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\DeleteFirewallPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

deleteKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\DeleteKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getFirewallPolicyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\GetFirewallPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\GetKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getMetricsAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listFirewallPoliciesAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listKeysAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listRelatedAccountGroupMembershipsAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

listRelatedAccountGroupsAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

migrateKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

retrieveLegacySecretKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

searchRelatedAccountGroupMembershipsAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateFirewallPolicyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\UpdateFirewallPolicyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

updateKeyAsync

Parameters
NameDescription
request Google\Cloud\RecaptchaEnterprise\V1\UpdateKeyRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

static::assessmentName

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

Parameters
NameDescription
project string
assessment string
Returns
TypeDescription
stringThe formatted assessment resource.

static::firewallPolicyName

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

Parameters
NameDescription
project string
firewallpolicy string
Returns
TypeDescription
stringThe formatted firewall_policy resource.

static::keyName

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

Parameters
NameDescription
project string
key string
Returns
TypeDescription
stringThe formatted key resource.

static::metricsName

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

Parameters
NameDescription
project string
key string
Returns
TypeDescription
stringThe formatted metrics resource.

static::projectName

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

Parameter
NameDescription
project string
Returns
TypeDescription
stringThe formatted project resource.

static::relatedAccountGroupName

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

Parameters
NameDescription
project string
relatedaccountgroup string
Returns
TypeDescription
stringThe 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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.