As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

RecaptchaEnterpriseService¶

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport, typing.Callable[[...], google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service to determine the likelihood an event is legitimate.

Instantiates the recaptcha enterprise service async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,RecaptchaEnterpriseServiceTransport,Callable[..., RecaptchaEnterpriseServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the RecaptchaEnterpriseServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async add_ip_override(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideRequest, dict]] = None, *, name: Optional[str] = None, ip_override_data: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_add_ip_override():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    ip_override_data = recaptchaenterprise_v1.IpOverrideData()
    ip_override_data.ip = "ip_value"
    ip_override_data.override_type = "ALLOW"

    request = recaptchaenterprise_v1.AddIpOverrideRequest(
        name="name_value",
        ip_override_data=ip_override_data,
    )

    # Make the request
    response = await client.add_ip_override(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.AddIpOverrideRequest, dict]]) – The request object. The AddIpOverride request message.
name (str) –
Required. The name of the key to which the IP override is added, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
ip_override_data (google.cloud.recaptchaenterprise_v1.types.IpOverrideData) –
Required. IP override added to the key.

This corresponds to the ip_override_data field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for AddIpOverride.

Return type

google.cloud.recaptchaenterprise_v1.types.AddIpOverrideResponse

async annotate_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, *, name: Optional[str] = None, annotation: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentResponse[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_annotate_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.AnnotateAssessmentRequest(
        name="name_value",
    )

    # Make the request
    response = await client.annotate_assessment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]]) – The request object. The request message to annotate an Assessment.
name (str) –
Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation) –
Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

This corresponds to the annotation field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Empty response for AnnotateAssessment.

Return type

google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static assessment_path(project: str, assessment: str) → str¶: Returns a fully-qualified assessment string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest, dict]] = None, *, parent: Optional[str] = None, assessment: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment[source]¶

Creates an Assessment of the likelihood an event is legitimate.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_create_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateAssessmentRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_assessment(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]]) – The request object. The create assessment request message.
parent (str) –
Required. The name of the project in which the assessment is created, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
assessment (google.cloud.recaptchaenterprise_v1.types.Assessment) – Required. The assessment details. This corresponds to the assessment field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A reCAPTCHA Enterprise assessment resource.

Return type

google.cloud.recaptchaenterprise_v1.types.Assessment

async create_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateFirewallPolicyRequest, dict]] = None, *, parent: Optional[str] = None, firewall_policy: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_create_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateFirewallPolicyRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateFirewallPolicyRequest, dict]]) – The request object. The create firewall policy request message.
parent (str) –
Required. The name of the project this policy applies to, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
firewall_policy (google.cloud.recaptchaenterprise_v1.types.FirewallPolicy) –
Required. Information to create the policy.

This corresponds to the firewall_policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

async create_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest, dict]] = None, *, parent: Optional[str] = None, key: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Creates a new reCAPTCHA Enterprise key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_create_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.CreateKeyRequest(
        parent="parent_value",
        key=key,
    )

    # Make the request
    response = await client.create_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]]) – The request object. The create key request message.
parent (str) –
Required. The name of the project in which the key is created, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
key (google.cloud.recaptchaenterprise_v1.types.Key) –
Required. Information to create a reCAPTCHA Enterprise key.

This corresponds to the key field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

async delete_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteFirewallPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_delete_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_firewall_policy(request=request)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.DeleteFirewallPolicyRequest, dict]]) – The request object. The delete firewall policy request message.
name (str) –
Required. The name of the policy to be deleted, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_delete_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteKeyRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_key(request=request)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]]) – The request object. The delete key request message.
name (str) –
Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static firewall_policy_path(project: str, firewallpolicy: str) → str¶: Returns a fully-qualified firewall_policy string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceAsyncClient

async get_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetFirewallPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Returns the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_get_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetFirewallPolicyRequest, dict]]) – The request object. The get firewall policy request message.
name (str) –
Required. The name of the requested policy, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

async get_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Returns the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_get_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetKeyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]]) – The request object. The get key request message.
name (str) –
Required. The name of the requested key, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

async get_metrics(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Metrics[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_get_metrics():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetMetricsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_metrics(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]]) – The request object. The get metrics request message.
name (str) –
Required. The name of the requested metrics, in the format projects/{project}/keys/{key}/metrics.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Metrics for a single Key.

Return type

google.cloud.recaptchaenterprise_v1.types.Metrics

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

static key_path(project: str, key: str) → str¶: Returns a fully-qualified key string.

async list_firewall_policies(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesAsyncPager[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_list_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListFirewallPoliciesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_firewall_policies(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesRequest, dict]]) – The request object. The list firewall policies request message.
parent (str) –
Required. The name of the project to list the policies for, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response to request to list firewall policies belonging to a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesAsyncPager

async list_ip_overrides(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesAsyncPager[source]¶

Lists all IP overrides for a key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_list_ip_overrides():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListIpOverridesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_ip_overrides(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListIpOverridesRequest, dict]]) – The request object. The ListIpOverrides request message.
parent (str) –
Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListIpOverrides.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesAsyncPager

async list_keys(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_list_keys():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListKeysRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_keys(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]]) – The request object. The list keys request message.
parent (str) –
Required. The name of the project that contains the keys that is listed, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager

async list_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager[source]¶

Get memberships in a group of related accounts.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_list_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_group_memberships(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]]) – The request object. The request message to list memberships in a related account group.
parent (str) –
Required. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a ListRelatedAccountGroupMemberships call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager

async list_related_account_groups(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager[source]¶

List groups of related accounts.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_list_related_account_groups():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_groups(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]]) – The request object. The request message to list related account groups.
parent (str) –
Required. The name of the project to list related account groups from, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a ListRelatedAccountGroups call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager

static metrics_path(project: str, key: str) → str¶: Returns a fully-qualified metrics string.

async migrate_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_migrate_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.MigrateKeyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.migrate_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]]) – The request object. The migrate key request message.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

static parse_assessment_path(path: str) → Dict[str, str]¶: Parses a assessment path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_firewall_policy_path(path: str) → Dict[str, str]¶: Parses a firewall_policy path into its component segments.

static parse_key_path(path: str) → Dict[str, str]¶: Parses a key path into its component segments.

static parse_metrics_path(path: str) → Dict[str, str]¶: Parses a metrics path into its component segments.

static parse_related_account_group_membership_path(path: str) → Dict[str, str]¶: Parses a related_account_group_membership path into its component segments.

static parse_related_account_group_path(path: str) → Dict[str, str]¶: Parses a related_account_group path into its component segments.

static related_account_group_membership_path(project: str, relatedaccountgroup: str, membership: str) → str¶: Returns a fully-qualified related_account_group_membership string.

static related_account_group_path(project: str, relatedaccountgroup: str) → str¶: Returns a fully-qualified related_account_group string.

async remove_ip_override(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideRequest, dict]] = None, *, name: Optional[str] = None, ip_override_data: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_remove_ip_override():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    ip_override_data = recaptchaenterprise_v1.IpOverrideData()
    ip_override_data.ip = "ip_value"
    ip_override_data.override_type = "ALLOW"

    request = recaptchaenterprise_v1.RemoveIpOverrideRequest(
        name="name_value",
        ip_override_data=ip_override_data,
    )

    # Make the request
    response = await client.remove_ip_override(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.RemoveIpOverrideRequest, dict]]) – The request object. The removeIpOverride request message.
name (str) –
Required. The name of the key from which the IP override is removed, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
ip_override_data (google.cloud.recaptchaenterprise_v1.types.IpOverrideData) –
Required. IP override to be removed from the key.

This corresponds to the ip_override_data field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for RemoveIpOverride.

Return type

google.cloud.recaptchaenterprise_v1.types.RemoveIpOverrideResponse

async reorder_firewall_policies(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesResponse[source]¶

Reorders all firewall policies.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_reorder_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ReorderFirewallPoliciesRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    response = await client.reorder_firewall_policies(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.ReorderFirewallPoliciesRequest, dict]]) – The request object. The reorder firewall policies request message.
parent (str) –
Required. The name of the project to list the policies for, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. A list containing all policy names, in the new order. Each name is in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the names field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The reorder firewall policies response message.

Return type

google.cloud.recaptchaenterprise_v1.types.ReorderFirewallPoliciesResponse

async retrieve_legacy_secret_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, *, key: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_retrieve_legacy_secret_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest(
        key="key_value",
    )

    # Make the request
    response = await client.retrieve_legacy_secret_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]]) – The request object. The retrieve legacy secret key request message.
key (str) –
Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.

This corresponds to the key field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.

Return type

google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse

async search_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, *, project: Optional[str] = None, hashed_account_id: Optional[bytes] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager[source]¶

Search group memberships related to a given account.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_search_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.search_related_account_group_memberships(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]]) – The request object. The request message to search related account group memberships.
project (str) –
Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

This corresponds to the project field on the request instance; if request is provided, this should not be set.
hashed_account_id (bytes) –
Optional. Deprecated: use account_id instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a hashed_account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

This corresponds to the hashed_account_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a SearchRelatedAccountGroupMemberships call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager

property transport: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: RecaptchaEnterpriseServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateFirewallPolicyRequest, dict]] = None, *, firewall_policy: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Updates the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_update_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.UpdateFirewallPolicyRequest(
    )

    # Make the request
    response = await client.update_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.UpdateFirewallPolicyRequest, dict]]) – The request object. The update firewall policy request message.
firewall_policy (google.cloud.recaptchaenterprise_v1.types.FirewallPolicy) – Required. The policy to update. This corresponds to the firewall_policy field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

async update_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest, dict]] = None, *, key: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Updates the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

async def sample_update_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceAsyncClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.UpdateKeyRequest(
        key=key,
    )

    # Make the request
    response = await client.update_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]]) – The request object. The update key request message.
key (google.cloud.recaptchaenterprise_v1.types.Key) – Required. The key to update. This corresponds to the key field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport, typing.Callable[[...], google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Service to determine the likelihood an event is legitimate.

Instantiates the recaptcha enterprise service client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,RecaptchaEnterpriseServiceTransport,Callable[..., RecaptchaEnterpriseServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the RecaptchaEnterpriseServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_ip_override(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideRequest, dict]] = None, *, name: Optional[str] = None, ip_override_data: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_add_ip_override():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    ip_override_data = recaptchaenterprise_v1.IpOverrideData()
    ip_override_data.ip = "ip_value"
    ip_override_data.override_type = "ALLOW"

    request = recaptchaenterprise_v1.AddIpOverrideRequest(
        name="name_value",
        ip_override_data=ip_override_data,
    )

    # Make the request
    response = client.add_ip_override(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.AddIpOverrideRequest, dict]) – The request object. The AddIpOverride request message.
name (str) –
Required. The name of the key to which the IP override is added, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
ip_override_data (google.cloud.recaptchaenterprise_v1.types.IpOverrideData) –
Required. IP override added to the key.

This corresponds to the ip_override_data field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for AddIpOverride.

Return type

google.cloud.recaptchaenterprise_v1.types.AddIpOverrideResponse

annotate_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest, dict]] = None, *, name: Optional[str] = None, annotation: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentResponse[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_annotate_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.AnnotateAssessmentRequest(
        name="name_value",
    )

    # Make the request
    response = client.annotate_assessment(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest, dict]) – The request object. The request message to annotate an Assessment.
name (str) –
Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation) –
Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

This corresponds to the annotation field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Empty response for AnnotateAssessment.

Return type

google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static assessment_path(project: str, assessment: str) → str[source]¶: Returns a fully-qualified assessment string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_assessment(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest, dict]] = None, *, parent: Optional[str] = None, assessment: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment[source]¶

Creates an Assessment of the likelihood an event is legitimate.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_assessment():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateAssessmentRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_assessment(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest, dict]) – The request object. The create assessment request message.
parent (str) –
Required. The name of the project in which the assessment is created, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
assessment (google.cloud.recaptchaenterprise_v1.types.Assessment) – Required. The assessment details. This corresponds to the assessment field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A reCAPTCHA Enterprise assessment resource.

Return type

google.cloud.recaptchaenterprise_v1.types.Assessment

create_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateFirewallPolicyRequest, dict]] = None, *, parent: Optional[str] = None, firewall_policy: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.CreateFirewallPolicyRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.CreateFirewallPolicyRequest, dict]) – The request object. The create firewall policy request message.
parent (str) –
Required. The name of the project this policy applies to, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
firewall_policy (google.cloud.recaptchaenterprise_v1.types.FirewallPolicy) –
Required. Information to create the policy.

This corresponds to the firewall_policy field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

create_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest, dict]] = None, *, parent: Optional[str] = None, key: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Creates a new reCAPTCHA Enterprise key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_create_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.CreateKeyRequest(
        parent="parent_value",
        key=key,
    )

    # Make the request
    response = client.create_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]) – The request object. The create key request message.
parent (str) –
Required. The name of the project in which the key is created, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
key (google.cloud.recaptchaenterprise_v1.types.Key) –
Required. Information to create a reCAPTCHA Enterprise key.

This corresponds to the key field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

delete_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteFirewallPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_delete_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    client.delete_firewall_policy(request=request)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.DeleteFirewallPolicyRequest, dict]) – The request object. The delete firewall policy request message.
name (str) –
Required. The name of the policy to be deleted, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_delete_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.DeleteKeyRequest(
        name="name_value",
    )

    # Make the request
    client.delete_key(request=request)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest, dict]) – The request object. The delete key request message.
name (str) –
Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static firewall_policy_path(project: str, firewallpolicy: str) → str[source]¶: Returns a fully-qualified firewall_policy string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

RecaptchaEnterpriseServiceClient

get_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetFirewallPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Returns the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetFirewallPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.GetFirewallPolicyRequest, dict]) – The request object. The get firewall policy request message.
name (str) –
Required. The name of the requested policy, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

get_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Returns the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetKeyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.GetKeyRequest, dict]) – The request object. The get key request message.
name (str) –
Required. The name of the requested key, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

get_metrics(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Metrics[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_get_metrics():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.GetMetricsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_metrics(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.GetMetricsRequest, dict]) – The request object. The get metrics request message.
name (str) –
Required. The name of the requested metrics, in the format projects/{project}/keys/{key}/metrics.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Metrics for a single Key.

Return type

google.cloud.recaptchaenterprise_v1.types.Metrics

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

static key_path(project: str, key: str) → str[source]¶: Returns a fully-qualified key string.

list_firewall_policies(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesPager[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListFirewallPoliciesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_firewall_policies(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesRequest, dict]) – The request object. The list firewall policies request message.
parent (str) –
Required. The name of the project to list the policies for, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response to request to list firewall policies belonging to a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesPager

list_ip_overrides(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesPager[source]¶

Lists all IP overrides for a key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_ip_overrides():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListIpOverridesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_ip_overrides(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ListIpOverridesRequest, dict]) – The request object. The ListIpOverrides request message.
parent (str) –
Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for ListIpOverrides.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesPager

list_keys(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager[source]¶

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

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_keys():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListKeysRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_keys(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ListKeysRequest, dict]) – The request object. The list keys request message.
parent (str) –
Required. The name of the project that contains the keys that is listed, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager

list_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager[source]¶

Get memberships in a group of related accounts.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupMembershipsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_group_memberships(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest, dict]) – The request object. The request message to list memberships in a related account group.
parent (str) –
Required. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a ListRelatedAccountGroupMemberships call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager

list_related_account_groups(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager[source]¶

List groups of related accounts.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_list_related_account_groups():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ListRelatedAccountGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_related_account_groups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest, dict]) – The request object. The request message to list related account groups.
parent (str) –
Required. The name of the project to list related account groups from, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a ListRelatedAccountGroups call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager

static metrics_path(project: str, key: str) → str[source]¶: Returns a fully-qualified metrics string.

migrate_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_migrate_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.MigrateKeyRequest(
        name="name_value",
    )

    # Make the request
    response = client.migrate_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.MigrateKeyRequest, dict]) – The request object. The migrate key request message.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

static parse_assessment_path(path: str) → Dict[str, str][source]¶: Parses a assessment path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_firewall_policy_path(path: str) → Dict[str, str][source]¶: Parses a firewall_policy path into its component segments.

static parse_key_path(path: str) → Dict[str, str][source]¶: Parses a key path into its component segments.

static parse_metrics_path(path: str) → Dict[str, str][source]¶: Parses a metrics path into its component segments.

static parse_related_account_group_membership_path(path: str) → Dict[str, str][source]¶: Parses a related_account_group_membership path into its component segments.

static parse_related_account_group_path(path: str) → Dict[str, str][source]¶: Parses a related_account_group path into its component segments.

static related_account_group_membership_path(project: str, relatedaccountgroup: str, membership: str) → str[source]¶: Returns a fully-qualified related_account_group_membership string.

static related_account_group_path(project: str, relatedaccountgroup: str) → str[source]¶: Returns a fully-qualified related_account_group string.

remove_ip_override(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideRequest, dict]] = None, *, name: Optional[str] = None, ip_override_data: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_remove_ip_override():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    ip_override_data = recaptchaenterprise_v1.IpOverrideData()
    ip_override_data.ip = "ip_value"
    ip_override_data.override_type = "ALLOW"

    request = recaptchaenterprise_v1.RemoveIpOverrideRequest(
        name="name_value",
        ip_override_data=ip_override_data,
    )

    # Make the request
    response = client.remove_ip_override(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.RemoveIpOverrideRequest, dict]) – The request object. The removeIpOverride request message.
name (str) –
Required. The name of the key from which the IP override is removed, in the format projects/{project}/keys/{key}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
ip_override_data (google.cloud.recaptchaenterprise_v1.types.IpOverrideData) –
Required. IP override to be removed from the key.

This corresponds to the ip_override_data field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for RemoveIpOverride.

Return type

google.cloud.recaptchaenterprise_v1.types.RemoveIpOverrideResponse

reorder_firewall_policies(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, names: Optional[MutableSequence[str]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesResponse[source]¶

Reorders all firewall policies.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_reorder_firewall_policies():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.ReorderFirewallPoliciesRequest(
        parent="parent_value",
        names=['names_value1', 'names_value2'],
    )

    # Make the request
    response = client.reorder_firewall_policies(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.ReorderFirewallPoliciesRequest, dict]) – The request object. The reorder firewall policies request message.
parent (str) –
Required. The name of the project to list the policies for, in the format projects/{project}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
names (MutableSequence[str]) –
Required. A list containing all policy names, in the new order. Each name is in the format projects/{project}/firewallpolicies/{firewallpolicy}.

This corresponds to the names field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The reorder firewall policies response message.

Return type

google.cloud.recaptchaenterprise_v1.types.ReorderFirewallPoliciesResponse

retrieve_legacy_secret_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyRequest, dict]] = None, *, key: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyResponse[source]¶

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.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_retrieve_legacy_secret_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.RetrieveLegacySecretKeyRequest(
        key="key_value",
    )

    # Make the request
    response = client.retrieve_legacy_secret_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyRequest, dict]) – The request object. The retrieve legacy secret key request message.
key (str) –
Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.

This corresponds to the key field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party integration with legacy reCAPTCHA.

Return type

google.cloud.recaptchaenterprise_v1.types.RetrieveLegacySecretKeyResponse

search_related_account_group_memberships(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, dict]] = None, *, project: Optional[str] = None, hashed_account_id: Optional[bytes] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager[source]¶

Search group memberships related to a given account.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_search_related_account_group_memberships():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.SearchRelatedAccountGroupMembershipsRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.search_related_account_group_memberships(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest, dict]) – The request object. The request message to search related account group memberships.
project (str) –
Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

This corresponds to the project field on the request instance; if request is provided, this should not be set.
hashed_account_id (bytes) –
Optional. Deprecated: use account_id instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a hashed_account_id provided in a previous CreateAssessment or AnnotateAssessment call. Either hashed_account_id or account_id must be set, but not both.

This corresponds to the hashed_account_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response to a SearchRelatedAccountGroupMemberships call.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager

property transport: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

RecaptchaEnterpriseServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_firewall_policy(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateFirewallPolicyRequest, dict]] = None, *, firewall_policy: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy[source]¶

Updates the specified firewall policy.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_update_firewall_policy():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    request = recaptchaenterprise_v1.UpdateFirewallPolicyRequest(
    )

    # Make the request
    response = client.update_firewall_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.UpdateFirewallPolicyRequest, dict]) – The request object. The update firewall policy request message.
firewall_policy (google.cloud.recaptchaenterprise_v1.types.FirewallPolicy) – Required. The policy to update. This corresponds to the firewall_policy field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A FirewallPolicy represents a single matching pattern and resulting actions to take.

Return type

google.cloud.recaptchaenterprise_v1.types.FirewallPolicy

update_key(request: Optional[Union[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest, dict]] = None, *, key: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key[source]¶

Updates the specified key.

# This snippet 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 as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import recaptchaenterprise_v1

def sample_update_key():
    # Create a client
    client = recaptchaenterprise_v1.RecaptchaEnterpriseServiceClient()

    # Initialize request argument(s)
    key = recaptchaenterprise_v1.Key()
    key.web_settings.integration_type = "INVISIBLE"
    key.display_name = "display_name_value"

    request = recaptchaenterprise_v1.UpdateKeyRequest(
        key=key,
    )

    # Make the request
    response = client.update_key(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest, dict]) – The request object. The update key request message.
key (google.cloud.recaptchaenterprise_v1.types.Key) – Required. The key to update. This corresponds to the key field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Return type

google.cloud.recaptchaenterprise_v1.types.Key

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_firewall_policies requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse object, and provides an __aiter__ method to iterate through its firewall_policies field.

If there are more pages, the __aiter__ method will make additional ListFirewallPolicies requests and continue to iterate through the firewall_policies field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_firewall_policies requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse object, and provides an __iter__ method to iterate through its firewall_policies field.

If there are more pages, the __iter__ method will make additional ListFirewallPolicies requests and continue to iterate through the firewall_policies field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListFirewallPoliciesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_ip_overrides requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse object, and provides an __aiter__ method to iterate through its ip_overrides field.

If there are more pages, the __aiter__ method will make additional ListIpOverrides requests and continue to iterate through the ip_overrides field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListIpOverridesRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_ip_overrides requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse object, and provides an __iter__ method to iterate through its ip_overrides field.

If there are more pages, the __iter__ method will make additional ListIpOverrides requests and continue to iterate through the ip_overrides field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListIpOverridesRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListIpOverridesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_keys requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListKeysResponse object, and provides an __aiter__ method to iterate through its keys field.

If there are more pages, the __aiter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_keys requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListKeysResponse object, and provides an __iter__ method to iterate through its keys field.

If there are more pages, the __iter__ method will make additional ListKeys requests and continue to iterate through the keys field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListKeysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListKeysRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListKeysResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_related_account_group_memberships requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse object, and provides an __aiter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __aiter__ method will make additional ListRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_related_account_group_memberships requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse object, and provides an __iter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __iter__ method will make additional ListRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupMembershipsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_related_account_groups requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse object, and provides an __aiter__ method to iterate through its related_account_groups field.

If there are more pages, the __aiter__ method will make additional ListRelatedAccountGroups requests and continue to iterate through the related_account_groups field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_related_account_groups requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse object, and provides an __iter__ method to iterate through its related_account_groups field.

If there are more pages, the __iter__ method will make additional ListRelatedAccountGroups requests and continue to iterate through the related_account_groups field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.ListRelatedAccountGroupsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager(method: Callable[[...], Awaitable[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse]], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_related_account_group_memberships requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse object, and provides an __aiter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __aiter__ method will make additional SearchRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager(method: Callable[[...], google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse], request: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest, response: google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through search_related_account_group_memberships requests.

This class thinly wraps an initial google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse object, and provides an __iter__ method to iterate through its related_account_group_memberships field.

If there are more pages, the __iter__ method will make additional SearchRelatedAccountGroupMemberships requests and continue to iterate through the related_account_group_memberships field on the corresponding responses.

All the usual google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsRequest) – The initial request object.
response (google.cloud.recaptchaenterprise_v1.types.SearchRelatedAccountGroupMembershipsResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

RecaptchaEnterpriseService¶

google-cloud-recaptcha-enterprise

Navigation

Related Topics