PHPFUI/InstaDoc

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.

CloneableFinalInstantiable

Traits
Google\ApiCore\GapicClientTrait
Google\ApiCore\ResourceHelperTrait

Properties

public static $serviceScopes = ['https://www.googleapis.com/auth/cloud-platform']

The default scopes required by the service.

Methods

public __call( $method, $args)

Handles execution of the async variants for each documented method.

public __construct(Google\ApiCore\Options\ClientOptions|array $options = [])

Constructor.

param array|\ClientOptions $options { Optional. Options for configuring the service API wrapper.

@type string $apiEndpoint
      The address of the API remote host. May optionally include the port, formatted
      as "<uri>:<port>". Default 'recaptchaenterprise.googleapis.com:443'.
@type FetchAuthTokenInterface|CredentialsWrapper $credentials
      This option should only be used with a pre-constructed
      {@see \FetchAuthTokenInterface} or {@see \CredentialsWrapper} object. Note that
      when one of these objects are provided, any settings in $credentialsConfig will
      be ignored.
      **Important**: If you are providing a path to a credentials file, or a decoded
      credentials file as a PHP array, this usage is now DEPRECATED. Providing an
      unvalidated credential configuration to Google APIs can compromise the security
      of your systems and data. It is recommended to create the credentials explicitly
      ```
      use Google\Auth\Credentials\ServiceAccountCredentials;
      use Google\Cloud\RecaptchaEnterprise\V1\RecaptchaEnterpriseServiceClient;
      $creds = new ServiceAccountCredentials($scopes, $json);
      $options = new RecaptchaEnterpriseServiceClient(['credentials' => $creds]);
      ```
      {@see https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
@type array $credentialsConfig
      Options used to configure credentials, including auth token caching, for the
      client. For a full list of supporting configuration options, see
      {@see \Google\ApiCore\CredentialsWrapper::build()} .
@type bool $disableRetries
      Determines whether or not retries defined by the client configuration should be
      disabled. Defaults to `false`.
@type string|array $clientConfig
      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.
@type string|TransportInterface $transport
      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 {@see \Google\ApiCore\Transport\TransportInterface} object. Note
      that when this object is provided, any settings in $transportConfig, and any
      $apiEndpoint setting, will be ignored.
@type array $transportConfig
      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 {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
      {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
      supported options.
@type callable $clientCertSource
      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.
@type false|LoggerInterface $logger
      A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
      'GOOGLE_SDK_PHP_LOGGING' environment flag
@type string $universeDomain
      The service domain for the client. Defaults to 'googleapis.com'.

}

throws \ValidationException

public addIpOverride(Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\AddIpOverrideResponse

Adds an IP override to a key. The following restrictions hold:

The maximum number of IP overrides per key is 1000.

For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

The async variant is {@see \RecaptchaEnterpriseServiceClient::addIpOverrideAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/add_ip_override.php
param \AddIpOverrideRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \AddIpOverrideResponse
throws \ApiException Thrown if the API call fails.

public addMiddleware(callable $middlewareCallable) : void

Add a middleware to the call stack by providing a callable which will be invoked at the start of each call, and will return an instance of {@see MiddlewareInterface} when invoked.

The callable must have the following method signature:

callable(MiddlewareInterface): MiddlewareInterface

An implementation may look something like this:

$client->addMiddleware(function (MiddlewareInterface $handler) {
    return new class ($handler) implements MiddlewareInterface {
        public function __construct(private MiddlewareInterface $handler) {
        }

        public function __invoke(Call $call, array $options) {
            // modify call and options (pre-request)
            $response = ($this->handler)($call, $options);
            // modify the response (post-request)
            return $response;
        }
    };
});

param callable $middlewareCallable A callable which returns an instance of {@see \MiddlewareInterface} when invoked with a MiddlewareInterface instance as its first argument.
return void

public annotateAssessment(Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentResponse

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

The async variant is {@see \RecaptchaEnterpriseServiceClient::annotateAssessmentAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/annotate_assessment.php
param \AnnotateAssessmentRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \AnnotateAssessmentResponse
throws \ApiException Thrown if the API call fails.

public static assessmentName(string $project, string $assessment) : string

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

param string $project
param string $assessment
return string The formatted assessment resource.

public close()

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.

experimental

public createAssessment(Google\Cloud\RecaptchaEnterprise\V1\CreateAssessmentRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Assessment

Creates an Assessment of the likelihood an event is legitimate.

The async variant is {@see \RecaptchaEnterpriseServiceClient::createAssessmentAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/create_assessment.php
param \CreateAssessmentRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Assessment
throws \ApiException Thrown if the API call fails.

public createFirewallPolicy(Google\Cloud\RecaptchaEnterprise\V1\CreateFirewallPolicyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

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 {@see \RecaptchaEnterpriseServiceClient::createFirewallPolicyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/create_firewall_policy.php
param \CreateFirewallPolicyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \FirewallPolicy
throws \ApiException Thrown if the API call fails.

public createKey(Google\Cloud\RecaptchaEnterprise\V1\CreateKeyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Key

Creates a new reCAPTCHA Enterprise key.

The async variant is {@see \RecaptchaEnterpriseServiceClient::createKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/create_key.php
param \CreateKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Key
throws \ApiException Thrown if the API call fails.

public deleteFirewallPolicy(Google\Cloud\RecaptchaEnterprise\V1\DeleteFirewallPolicyRequest $request, array $callOptions = []) : void

Deletes the specified firewall policy.

The async variant is {@see \RecaptchaEnterpriseServiceClient::deleteFirewallPolicyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/delete_firewall_policy.php
param \DeleteFirewallPolicyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

throws \ApiException Thrown if the API call fails.

public deleteKey(Google\Cloud\RecaptchaEnterprise\V1\DeleteKeyRequest $request, array $callOptions = []) : void

Deletes the specified key.

The async variant is {@see \RecaptchaEnterpriseServiceClient::deleteKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/delete_key.php
param \DeleteKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

throws \ApiException Thrown if the API call fails.

public static firewallPolicyName(string $project, string $firewallpolicy) : string

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

param string $project
param string $firewallpolicy
return string The formatted firewall_policy resource.

public getFirewallPolicy(Google\Cloud\RecaptchaEnterprise\V1\GetFirewallPolicyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

Returns the specified firewall policy.

The async variant is {@see \RecaptchaEnterpriseServiceClient::getFirewallPolicyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/get_firewall_policy.php
param \GetFirewallPolicyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \FirewallPolicy
throws \ApiException Thrown if the API call fails.

public getKey(Google\Cloud\RecaptchaEnterprise\V1\GetKeyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Key

Returns the specified key.

The async variant is {@see \RecaptchaEnterpriseServiceClient::getKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/get_key.php
param \GetKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Key
throws \ApiException Thrown if the API call fails.

public getMetrics(Google\Cloud\RecaptchaEnterprise\V1\GetMetricsRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Metrics

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

The async variant is {@see \RecaptchaEnterpriseServiceClient::getMetricsAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/get_metrics.php
param \GetMetricsRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Metrics
throws \ApiException Thrown if the API call fails.

public static keyName(string $project, string $key) : string

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

param string $project
param string $key
return string The formatted key resource.

public listFirewallPolicies(Google\Cloud\RecaptchaEnterprise\V1\ListFirewallPoliciesRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

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

The async variant is {@see \RecaptchaEnterpriseServiceClient::listFirewallPoliciesAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/list_firewall_policies.php
param \ListFirewallPoliciesRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public listIpOverrides(Google\Cloud\RecaptchaEnterprise\V1\ListIpOverridesRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

Lists all IP overrides for a key.

The async variant is {@see \RecaptchaEnterpriseServiceClient::listIpOverridesAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/list_ip_overrides.php
param \ListIpOverridesRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public listKeys(Google\Cloud\RecaptchaEnterprise\V1\ListKeysRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

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

The async variant is {@see \RecaptchaEnterpriseServiceClient::listKeysAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/list_keys.php
param \ListKeysRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public listRelatedAccountGroupMemberships(Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupMembershipsRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

Get memberships in a group of related accounts.

The async variant is {@see \RecaptchaEnterpriseServiceClient::listRelatedAccountGroupMembershipsAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/list_related_account_group_memberships.php
param \ListRelatedAccountGroupMembershipsRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public listRelatedAccountGroups(Google\Cloud\RecaptchaEnterprise\V1\ListRelatedAccountGroupsRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

List groups of related accounts.

The async variant is {@see \RecaptchaEnterpriseServiceClient::listRelatedAccountGroupsAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/list_related_account_groups.php
param \ListRelatedAccountGroupsRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public static metricsName(string $project, string $key) : string

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

param string $project
param string $key
return string The formatted metrics resource.

public migrateKey(Google\Cloud\RecaptchaEnterprise\V1\MigrateKeyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Key

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 {@see \RecaptchaEnterpriseServiceClient::migrateKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/migrate_key.php
param \MigrateKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Key
throws \ApiException Thrown if the API call fails.

public static parseName(string $formattedName, ?string $template = NULL) : array

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.

param string $formattedName The formatted name string
param ?string $template Optional name of template to match
return array An associative array from name component IDs to component values.
throws \ValidationException If $formattedName could not be matched.

public prependMiddleware(callable $middlewareCallable) : void

Prepend a middleware to the call stack by providing a callable which will be invoked at the end of each call, and will return an instance of {@see MiddlewareInterface} when invoked.

The callable must have the following method signature:

callable(MiddlewareInterface): MiddlewareInterface

An implementation may look something like this:

$client->prependMiddleware(function (MiddlewareInterface $handler) {
    return new class ($handler) implements MiddlewareInterface {
        public function __construct(private MiddlewareInterface $handler) {
        }

        public function __invoke(Call $call, array $options) {
            // modify call and options (pre-request)
            $response = ($this->handler)($call, $options);
            // modify the response (post-request)
            return $response;
        }
    };
});

param callable $middlewareCallable A callable which returns an instance of {@see \MiddlewareInterface} when invoked with a MiddlewareInterface instance as its first argument.
return void

public static projectName(string $project) : string

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

param string $project
return string The formatted project resource.

public static relatedAccountGroupName(string $project, string $relatedaccountgroup) : string

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

param string $project
param string $relatedaccountgroup
return string The formatted related_account_group resource.

public removeIpOverride(Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\RemoveIpOverrideResponse

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 {@see \RecaptchaEnterpriseServiceClient::removeIpOverrideAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/remove_ip_override.php
param \RemoveIpOverrideRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \RemoveIpOverrideResponse
throws \ApiException Thrown if the API call fails.

public reorderFirewallPolicies(Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\ReorderFirewallPoliciesResponse

Reorders all firewall policies.

The async variant is {@see \RecaptchaEnterpriseServiceClient::reorderFirewallPoliciesAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/reorder_firewall_policies.php
param \ReorderFirewallPoliciesRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \ReorderFirewallPoliciesResponse
throws \ApiException Thrown if the API call fails.

public retrieveLegacySecretKey(Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\RetrieveLegacySecretKeyResponse

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 {@see \RecaptchaEnterpriseServiceClient::retrieveLegacySecretKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/retrieve_legacy_secret_key.php
param \RetrieveLegacySecretKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \RetrieveLegacySecretKeyResponse
throws \ApiException Thrown if the API call fails.

public searchRelatedAccountGroupMemberships(Google\Cloud\RecaptchaEnterprise\V1\SearchRelatedAccountGroupMembershipsRequest $request, array $callOptions = []) : Google\ApiCore\PagedListResponse

Search group memberships related to a given account.

The async variant is {@see \RecaptchaEnterpriseServiceClient::searchRelatedAccountGroupMembershipsAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/search_related_account_group_memberships.php
param \SearchRelatedAccountGroupMembershipsRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \PagedListResponse
throws \ApiException Thrown if the API call fails.

public static traitValidate(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

public updateFirewallPolicy(Google\Cloud\RecaptchaEnterprise\V1\UpdateFirewallPolicyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\FirewallPolicy

Updates the specified firewall policy.

The async variant is {@see \RecaptchaEnterpriseServiceClient::updateFirewallPolicyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/update_firewall_policy.php
param \UpdateFirewallPolicyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \FirewallPolicy
throws \ApiException Thrown if the API call fails.

public updateKey(Google\Cloud\RecaptchaEnterprise\V1\UpdateKeyRequest $request, array $callOptions = []) : Google\Cloud\RecaptchaEnterprise\V1\Key

Updates the specified key.

The async variant is {@see \RecaptchaEnterpriseServiceClient::updateKeyAsync()} .

example samples/V1/RecaptchaEnterpriseServiceClient/update_key.php
param \UpdateKeyRequest $request A request to house fields associated with the call.

param array $callOptions { Optional.

@type RetrySettings|array $retrySettings
      Retry settings to use for this call. Can be a {@see \RetrySettings} object, or an
      associative array of retry settings parameters. See the documentation on
      {@see \RetrySettings} for example usage.

}

return \Key
throws \ApiException Thrown if the API call fails.

public static validate(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

public static validateNotNull(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

Methods

protected getCredentialsWrapper()

Get the credentials for the client. This method is protected to support use by customized clients.

access private
return \CredentialsWrapper

protected getTransport()

Get the transport for the client. This method is protected to support use by customized clients.

access private
return \TransportInterface

protected modifyClientOptions(array $options)

Modify options passed to the client before calling setClientOptions.

param array $options
access private
internal

protected modifyStreamingCallable(callable $callable)

Modify the streaming callable.

param callable $callable
access private

protected modifyUnaryCallable(callable $callable)

Modify the unary callable.

param callable $callable
access private

Constants

private Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::CODEGEN_NAME = 'gapic'

The name of the code generator, to be included in the agent header.

private Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::DEFAULT_SERVICE_PORT = 443

The default port of the service.

private Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::SERVICE_ADDRESS = 'recaptchaenterprise.googleapis.com'

The default address of the service.

deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.

private Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::SERVICE_ADDRESS_TEMPLATE = 'recaptchaenterprise.UNIVERSE_DOMAIN'

The address template of the service.

private Google\Cloud\RecaptchaEnterprise\V1\Client\RecaptchaEnterpriseServiceClient::SERVICE_NAME = 'google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService'

The name of the service.

Properties

private array $agentHeader = []

private bool $backwardsCompatibilityMode

private ?Google\ApiCore\HeaderCredentialsInterface $credentialsWrapper = NULL

private array $descriptors = []

private static $gapicVersionFromFile = NULL

private array $middlewareCallables = []

var callable[] $middlewareCallables

private array $prependMiddlewareCallables = []

var callable[] $prependMiddlewareCallables

private array $retrySettings = []

var \RetrySettings[] $retrySettings

private string $serviceName = ''

private static $templateMap = NULL

var array|null

private ?Google\ApiCore\Transport\TransportInterface $transport = NULL

private array $transportCallMethods = ['startUnaryCall', 'startBidiStreamingCall', 'startClientStreamingCall', 'startServerStreamingCall']

Methods

private arrayFilterRemoveNull(array $arr)

Just like array_filter(), but preserves falsey values except null.

param array $arr
return array

private arrayMergeRecursive(array $array1, array $array2)

A method, similar to PHP's array_merge_recursive, with two differences.

Keys in $array2 take precedence over keys in $array1.
Non-array keys found in both inputs are not transformed into an array and appended. Rather, the value in $array2 is used.

param array $array1
param array $array2
return array

private buildClientOptions(Google\ApiCore\Options\ClientOptions|array $options)

Resolve client options based on the client's default ({@see ClientOptionsTrait::getClientDefault}) and the default for all Google APIs.

Set default client option values
Set default logger (and log user-supplied configuration options)
Set default transport configuration
Call "modifyClientOptions" (for backwards compatibility)
Use "defaultScopes" when custom endpoint is supplied
Load mTLS from the environment if configured
Resolve endpoint based on universe domain template when possible
Load sysvshm grpc config when possible

private buildMethod(?string $interfaceName = NULL, ?string $methodName = NULL)

param string $interfaceName
param string $methodName
return string

private buildRequestParamsHeader(array $headerParams, ?Google\Protobuf\Internal\Message $request = NULL)

param array $headerParams
param \Message|null $request
return array

private configureCallConstructionOptions(string $methodName, array $optionalArgs)

param string $methodName

param array $optionalArgs { Optional arguments

@type RetrySettings|array $retrySettings [optional] A retry settings
      override for the call.

}

return array

private configureCallOptions(array $optionalArgs) : array

return array

private createCallStack(array $callConstructionOptions)

param array $callConstructionOptions { Call Construction Options

@type RetrySettings $retrySettings [optional] A retry settings override
      For the call.
@type array<string, string> $autoPopulationSettings Settings for
      auto population of particular request fields if unset.

}

return callable

private createCredentialsWrapper( $credentials, array $credentialsConfig, string $universeDomain)

param mixed $credentials
param array $credentialsConfig
return \CredentialsWrapper
throws \ValidationException

private createOperationsClient(array $options)

param array $options
return \OperationsClient

private createTransport(string $apiEndpoint, $transport, $transportConfig, ?callable $clientCertSource = NULL, bool $hasEmulator = false)

param string $apiEndpoint
param string $transport
param \TransportOptions|array $transportConfig
param callable $clientCertSource
param bool $hasEmulator
return \TransportInterface
throws \ValidationException

private static defaultTransport()

return string

private static determineMtlsEndpoint(string $apiEndpoint)

private static getClientDefaults()

private static getDefaultAudience()

The SERVICE_ADDRESS constant is set by GAPIC clients

private static getGapicVersion(array $options)

private static getGrpcDependencyStatus()

return bool

private getPagedListResponse(string $methodName, array $optionalArgs, string $decodeType, Google\Protobuf\Internal\Message $request, ?string $interfaceName = NULL)

param string $methodName
param array $optionalArgs
param string $decodeType
param \Message $request
param string $interfaceName
return \PagedListResponse

private getPagedListResponseAsync(string $methodName, array $optionalArgs, string $decodeType, Google\Protobuf\Internal\Message $request, ?string $interfaceName = NULL)

param string $methodName
param array $optionalArgs
param string $decodeType
param \Message $request
param string $interfaceName
return \PromiseInterface

private static getPathTemplate(string $key)

private static initGrpcGcpConfig(string $hostName, string $confPath)

private isAssoc(array $arr)

Determine whether given array is associative.

param array $arr
return bool

private isBackwardsCompatibilityMode() : bool

internal

private static loadPathTemplates(string $configPath, string $serviceName)

private logConfiguration(Psr\Log\LoggerInterface|false|?null $logger, array $options) : void

param null|false|\LoggerInterface $logger
param string $options

private static parseFormattedName(string $formattedName, ?string $template = NULL) : array

private pluck(string $key, array $arr, bool $isRequired = true)

Pluck a value out of an array.

param string $key
param array $arr
param bool $isRequired
return mixed|null
throws \InvalidArgumentException

private pluckArray(array $keys, array $arr)

Pluck a subset of an array.

param array $keys
param array $arr
return array

private static registerPathTemplates()

private setClientOptions(array $options)

Configures the GAPIC client based on an array of options.

param
array $options { An array of required and optional arguments.
```
@type string $apiEndpoint
      The address of the API remote host, for example "example.googleapis.com. May also
```
- ```
      include the port, for example "example.googleapis.com:443"
```
  @type bool $disableRetries Determines whether or not retries defined by the client configuration should be disabled. Defaults to false. @type string|array $clientConfig 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. @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials 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 $authConfig will be ignored. @type array $credentialsConfig 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. @type string|TransportInterface $transport The transport used for executing network requests. May be either the string rest, grpc, or 'grpc-fallback'. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated TransportInterface object. Note that when this objects is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored. @type array $transportConfig 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' => [...], 'grpc-fallback' => [...], ]; See the GrpcTransport::build and RestTransport::build methods for the supported options. @type string $versionFile The path to a file which contains the current version of the client. @type string $descriptorsConfigPath The path to a descriptor configuration file. @type string $serviceName The name of the service. @type string $libName The name of the client application. @type string $libVersion The version of the client application. @type string $gapicVersion The code generator version of the GAPIC library. @type callable $clientCertSource A callable which returns the client cert as a string. }
throws \ValidationException

private shouldUseMtlsEndpoint(array $options)

private startApiCall(string $methodName, ?Google\Protobuf\Internal\Message $request = NULL, array $optionalArgs = [])

param string $methodName
param \Message $request

param array $optionalArgs { Call Options

@type array $headers [optional] key-value array containing headers
@type int $timeoutMillis [optional] the timeout in milliseconds for the call
@type array $transportOptions [optional] transport-specific call options
@type RetrySettings|array $retrySettings [optional] A retry settings
      override for the call.

}

experimental
return \PromiseInterface|\PagedListResponse|\BidiStream|\ClientStream|\ServerStream

private startAsyncCall(string $methodName, Google\Protobuf\Internal\Message $request, array $optionalArgs = [])

param string $methodName
param \Message $request

param array $optionalArgs { Call Options

@type array $headers                     [optional] key-value array containing headers
@type int $timeoutMillis                 [optional] the timeout in milliseconds for the call
@type array $transportOptions            [optional] transport-specific call options
@type RetrySettings|array $retrySettings [optional] A retry settings override for the call.

}

experimental
return \PromiseInterface

private startCall(string $methodName, string $decodeType, array $optionalArgs = [], ?Google\Protobuf\Internal\Message $request = NULL, int $callType = 0Google\ApiCore\Call::UNARY_CALL, ?string $interfaceName = NULL)

param string $methodName
param string $decodeType

param array $optionalArgs { Call Options

@type array $headers [optional] key-value array containing headers
@type int $timeoutMillis [optional] the timeout in milliseconds for the call
@type array $transportOptions [optional] transport-specific call options
@type RetrySettings|array $retrySettings [optional] A retry settings
      override for the call.

}

param \Message $request
param int $callType
param string $interfaceName
return \PromiseInterface|\BidiStream|\ClientStream|\ServerStream

private startOperationsCall(string $methodName, array $optionalArgs, Google\Protobuf\Internal\Message $request, $client, ?string $interfaceName = NULL, ?string $operationClass = NULL)

param string $methodName

param array $optionalArgs { Call Options

@type array $headers [optional] key-value array containing headers
@type int $timeoutMillis [optional] the timeout in milliseconds for the call
@type array $transportOptions [optional] transport-specific call options

}

param \Message $request
param \OperationsClient|object $client
param string $interfaceName
param string $operationClass If provided, will be used instead of the default operation response class of {@see \Google\LongRunning\Operation}.
return \PromiseInterface

private subsetArray(array $keys, array $arr)

Return a subset of an array, like pluckArray, without modifying the original array.

param array $keys
param array $arr
return array

private static supportedTransports()

This defaults to all three transports, which One-Platform supports.

Discovery clients should define this function and only return ['rest'].

private validateCallConfig(string $methodName)

private static validateFileExists(string $filePath)

param string $filePath
throws \ValidationException

private static validateGrpcSupport()

throws \ValidationException

private static validateImpl( $arr, $requiredKeys, $allowNull)

Properties

private static $gapicVersionFromFile = NULL

public static $serviceScopes = ['https://www.googleapis.com/auth/cloud-platform']

The default scopes required by the service.

private static $templateMap = NULL

var array|null

Methods

public static assessmentName(string $project, string $assessment) : string

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

param string $project
param string $assessment
return string The formatted assessment resource.

private static defaultTransport()

return string

private static determineMtlsEndpoint(string $apiEndpoint)

public static firewallPolicyName(string $project, string $firewallpolicy) : string

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

param string $project
param string $firewallpolicy
return string The formatted firewall_policy resource.

private static getClientDefaults()

private static getDefaultAudience()

The SERVICE_ADDRESS constant is set by GAPIC clients

private static getGapicVersion(array $options)

private static getGrpcDependencyStatus()

return bool

private static getPathTemplate(string $key)

private static initGrpcGcpConfig(string $hostName, string $confPath)

public static keyName(string $project, string $key) : string

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

param string $project
param string $key
return string The formatted key resource.

private static loadPathTemplates(string $configPath, string $serviceName)

public static metricsName(string $project, string $key) : string

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

param string $project
param string $key
return string The formatted metrics resource.

private static parseFormattedName(string $formattedName, ?string $template = NULL) : array

public static parseName(string $formattedName, ?string $template = NULL) : array

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}

param string $formattedName The formatted name string
param ?string $template Optional name of template to match
return array An associative array from name component IDs to component values.
throws \ValidationException If $formattedName could not be matched.

public static projectName(string $project) : string

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

param string $project
return string The formatted project resource.

private static registerPathTemplates()

public static relatedAccountGroupName(string $project, string $relatedaccountgroup) : string

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

param string $project
param string $relatedaccountgroup
return string The formatted related_account_group resource.

private static supportedTransports()

This defaults to all three transports, which One-Platform supports.

Discovery clients should define this function and only return ['rest'].

public static traitValidate(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

public static validate(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

private static validateFileExists(string $filePath)

param string $filePath
throws \ValidationException

private static validateGrpcSupport()

throws \ValidationException

private static validateImpl( $arr, $requiredKeys, $allowNull)

public static validateNotNull(array $arr, array $requiredKeys)

param array $arr Associative array
param array $requiredKeys List of keys to check for in $arr
return array Returns $arr for fluent use

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only