RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: 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>)
Service to determine the likelihood an event is legitimate.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
RecaptchaEnterpriseServiceTransport | The transport used by the client instance. |
Methods
RecaptchaEnterpriseServiceClient
RecaptchaEnterpriseServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.transports.base.RecaptchaEnterpriseServiceTransport]] = None, client_options: 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>)
Instantiates the recaptcha enterprise service client.
Parameters | |
---|---|
Name | Description |
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 |
Union[str, RecaptchaEnterpriseServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
annotate_assessment
annotate_assessment(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest] = None, *, name: Optional[str] = None, annotation: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.AnnotateAssessmentRequest.Annotation] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest
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 |
annotation |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation
Required. The annotation that will be assigned to the Event. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentResponse | Empty response for AnnotateAssessment. |
assessment_path
assessment_path(project: str, assessment: str)
Returns a fully-qualified assessment string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_assessment
create_assessment(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateAssessmentRequest] = None, *, parent: Optional[str] = None, assessment: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.Assessment] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates an Assessment of the likelihood an event is legitimate.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.CreateAssessmentRequest
The request object. The create assessment request message. |
parent |
str
Required. The name of the project in which the assessment will be created, in the format "projects/{project}". This corresponds to the |
assessment |
google.cloud.recaptchaenterprise_v1.types.Assessment
Required. The assessment details. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.types.Assessment | A recaptcha assessment resource. |
create_key
create_key(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.CreateKeyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new reCAPTCHA Enterprise key.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest
The request object. The create 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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |
delete_key
delete_key(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.DeleteKeyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified key.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.DeleteKeyRequest
The request object. The delete 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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
RecaptchaEnterpriseServiceClient | The constructed client. |
get_key
get_key(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.GetKeyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the specified key.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.GetKeyRequest
The request object. The get 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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |
key_path
key_path(project: str, key: str)
Returns a fully-qualified key string.
list_keys
list_keys(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.ListKeysRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the list of all keys that belong to a project.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.ListKeysRequest
The request object. The list keys 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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.services.recaptcha_enterprise_service.pagers.ListKeysPager | Response to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically. |
parse_assessment_path
parse_assessment_path(path: str)
Parses a assessment path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_key_path
parse_key_path(path: str)
Parses a key path into its component segments.
update_key
update_key(request: Optional[google.cloud.recaptchaenterprise_v1.types.recaptchaenterprise.UpdateKeyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the specified key.
Parameters | |
---|---|
Name | Description |
request |
google.cloud.recaptchaenterprise_v1.types.UpdateKeyRequest
The request object. The update 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 | |
---|---|
Type | Description |
google.cloud.recaptchaenterprise_v1.types.Key | A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. |