Summary of entries of Methods for recaptchaenterprise.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient
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 =
Instantiates the recaptcha enterprise service async client.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.add_ip_override
add_ip_override(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ip_override_data: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideResponse
)
Adds an IP override to a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.annotate_assessment
annotate_assessment(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
annotation: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentResponse
)
Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.assessment_path
assessment_path(project: str, assessment: str) -> str
Returns a fully-qualified assessment string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.create_assessment
create_assessment(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
assessment: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment
Creates an Assessment of the likelihood an event is legitimate.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.create_firewall_policy
create_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateFirewallPolicyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
firewall_policy: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.create_key
create_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
key: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Creates a new reCAPTCHA Enterprise key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.delete_firewall_policy
delete_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteFirewallPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.delete_key
delete_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.firewall_policy_path
firewall_policy_path(project: str, firewallpolicy: str) -> str
Returns a fully-qualified firewall_policy string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.get_firewall_policy
get_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetFirewallPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Returns the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.get_key
get_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Returns the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.get_metrics
get_metrics(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Metrics
Get some aggregated metrics for a Key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport
]
Returns an appropriate transport class.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.key_path
key_path(project: str, key: str) -> str
Returns a fully-qualified key string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.list_firewall_policies
list_firewall_policies(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesAsyncPager
)
Returns the list of all firewall policies that belong to a project.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.list_ip_overrides
list_ip_overrides(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesAsyncPager
)
Lists all IP overrides for a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.list_keys
list_keys(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager
)
Returns the list of all keys that belong to a project.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.list_related_account_group_memberships
list_related_account_group_memberships(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager
)
Get memberships in a group of related accounts.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.list_related_account_groups
list_related_account_groups(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager
)
List groups of related accounts.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.metrics_path
metrics_path(project: str, key: str) -> str
Returns a fully-qualified metrics string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.migrate_key
migrate_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_assessment_path
parse_assessment_path(path: str) -> typing.Dict[str, str]
Parses a assessment path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_firewall_policy_path
parse_firewall_policy_path(path: str) -> typing.Dict[str, str]
Parses a firewall_policy path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_key_path
parse_key_path(path: str) -> typing.Dict[str, str]
Parses a key path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_metrics_path
parse_metrics_path(path: str) -> typing.Dict[str, str]
Parses a metrics path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_related_account_group_membership_path
parse_related_account_group_membership_path(path: str) -> typing.Dict[str, str]
Parses a related_account_group_membership path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.parse_related_account_group_path
parse_related_account_group_path(path: str) -> typing.Dict[str, str]
Parses a related_account_group path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.related_account_group_membership_path
related_account_group_membership_path(
project: str, relatedaccountgroup: str, membership: str
) -> str
Returns a fully-qualified related_account_group_membership string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.related_account_group_path
related_account_group_path(project: str, relatedaccountgroup: str) -> str
Returns a fully-qualified related_account_group string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.remove_ip_override
remove_ip_override(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ip_override_data: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideResponse
)
Removes an IP override from a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.reorder_firewall_policies
reorder_firewall_policies(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesResponse
)
Reorders all firewall policies.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.retrieve_legacy_secret_key
retrieve_legacy_secret_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyRequest,
dict,
]
] = None,
*,
key: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyResponse
)
Returns the secret key related to the specified public key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.search_related_account_group_memberships
search_related_account_group_memberships(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
hashed_account_id: typing.Optional[bytes] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager
)
Search group memberships related to a given account.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.update_firewall_policy
update_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_policy: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Updates the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceAsyncClient.update_key
update_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest,
dict,
]
] = None,
*,
key: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Updates the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient
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 =
Instantiates the recaptcha enterprise service client.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.add_ip_override
add_ip_override(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ip_override_data: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AddIpOverrideResponse
)
Adds an IP override to a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.annotate_assessment
annotate_assessment(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
annotation: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentResponse
)
Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.assessment_path
assessment_path(project: str, assessment: str) -> str
Returns a fully-qualified assessment string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.create_assessment
create_assessment(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
assessment: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment
Creates an Assessment of the likelihood an event is legitimate.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.create_firewall_policy
create_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateFirewallPolicyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
firewall_policy: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.create_key
create_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
key: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Creates a new reCAPTCHA Enterprise key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.delete_firewall_policy
delete_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteFirewallPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.delete_key
delete_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.firewall_policy_path
firewall_policy_path(project: str, firewallpolicy: str) -> str
Returns a fully-qualified firewall_policy string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.get_firewall_policy
get_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetFirewallPolicyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Returns the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.get_key
get_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Returns the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.get_metrics
get_metrics(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetMetricsRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Metrics
Get some aggregated metrics for a Key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.key_path
key_path(project: str, key: str) -> str
Returns a fully-qualified key string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.list_firewall_policies
list_firewall_policies(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListFirewallPoliciesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesPager
)
Returns the list of all firewall policies that belong to a project.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.list_ip_overrides
list_ip_overrides(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListIpOverridesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesPager
)
Lists all IP overrides for a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.list_keys
list_keys(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager
)
Returns the list of all keys that belong to a project.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.list_related_account_group_memberships
list_related_account_group_memberships(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupMembershipsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager
)
Get memberships in a group of related accounts.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.list_related_account_groups
list_related_account_groups(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListRelatedAccountGroupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager
)
List groups of related accounts.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.metrics_path
metrics_path(project: str, key: str) -> str
Returns a fully-qualified metrics string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.migrate_key
migrate_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.MigrateKeyRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_assessment_path
parse_assessment_path(path: str) -> typing.Dict[str, str]
Parses a assessment path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_firewall_policy_path
parse_firewall_policy_path(path: str) -> typing.Dict[str, str]
Parses a firewall_policy path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_key_path
parse_key_path(path: str) -> typing.Dict[str, str]
Parses a key path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_metrics_path
parse_metrics_path(path: str) -> typing.Dict[str, str]
Parses a metrics path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_related_account_group_membership_path
parse_related_account_group_membership_path(path: str) -> typing.Dict[str, str]
Parses a related_account_group_membership path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.parse_related_account_group_path
parse_related_account_group_path(path: str) -> typing.Dict[str, str]
Parses a related_account_group path into its component segments.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.related_account_group_membership_path
related_account_group_membership_path(
project: str, relatedaccountgroup: str, membership: str
) -> str
Returns a fully-qualified related_account_group_membership string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.related_account_group_path
related_account_group_path(project: str, relatedaccountgroup: str) -> str
Returns a fully-qualified related_account_group string.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.remove_ip_override
remove_ip_override(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ip_override_data: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.IpOverrideData
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RemoveIpOverrideResponse
)
Removes an IP override from a key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.reorder_firewall_policies
reorder_firewall_policies(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
names: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ReorderFirewallPoliciesResponse
)
Reorders all firewall policies.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.retrieve_legacy_secret_key
retrieve_legacy_secret_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyRequest,
dict,
]
] = None,
*,
key: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.RetrieveLegacySecretKeyResponse
)
Returns the secret key related to the specified public key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.search_related_account_group_memberships
search_related_account_group_memberships(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.SearchRelatedAccountGroupMembershipsRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
hashed_account_id: typing.Optional[bytes] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager
)
Search group memberships related to a given account.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.update_firewall_policy
update_firewall_policy(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_policy: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.FirewallPolicy
Updates the specified firewall policy.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.RecaptchaEnterpriseServiceClient.update_key
update_key(
request: typing.Optional[
typing.Union[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest,
dict,
]
] = None,
*,
key: typing.Optional[
google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Key
Updates the specified key.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesAsyncPager
ListFirewallPoliciesAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListFirewallPoliciesPager
ListFirewallPoliciesPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesAsyncPager
ListIpOverridesAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListIpOverridesPager
ListIpOverridesPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager
ListKeysAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysAsyncPager
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager
ListKeysPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsAsyncPager
ListRelatedAccountGroupMembershipsAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupMembershipsPager
ListRelatedAccountGroupMembershipsPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsAsyncPager
ListRelatedAccountGroupsAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListRelatedAccountGroupsPager
ListRelatedAccountGroupsPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsAsyncPager
SearchRelatedAccountGroupMembershipsAsyncPager(
method: typing.Callable[
[...],
typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.SearchRelatedAccountGroupMembershipsPager
SearchRelatedAccountGroupMembershipsPager(
method: typing.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: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.