Class RecaptchaEnterpriseServiceClient (0.1.0)

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: <module 'google.api_core.client_options' from '/workspace/python-recaptcha-enterprise/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'recaptchaenterprise.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

Service to determine the likelihood an event is legitimate.

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: <module 'google.api_core.client_options' from '/workspace/python-recaptcha-enterprise/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'recaptchaenterprise.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

Instantiate the recaptcha enterprise service client.

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

Custom options for the client.

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
NameDescription
request .recaptchaenterprise.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 name field on the request instance; if request is provided, this should not be set.

annotation .recaptchaenterprise.AnnotateAssessmentRequest.Annotation

Required. The annotation that will be assigned to the Event. 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
TypeDescription
.recaptchaenterprise.AnnotateAssessmentResponseEmpty response for AnnotateAssessment.

assessment_path

assessment_path(project: str, assessment: str)

Return a fully-qualified assessment 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
NameDescription
request .recaptchaenterprise.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 parent field on the request instance; if request is provided, this should not be set.

assessment .recaptchaenterprise.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
TypeDescription
.recaptchaenterprise.AssessmentA 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
NameDescription
request .recaptchaenterprise.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
TypeDescription
.recaptchaenterprise.KeyA 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
NameDescription
request .recaptchaenterprise.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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}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
NameDescription
request .recaptchaenterprise.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
TypeDescription
.recaptchaenterprise.KeyA key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

key_path

key_path(project: str, key: str)

Return 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
NameDescription
request .recaptchaenterprise.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
TypeDescription
.pagers.ListKeysPagerResponse to request to list keys in a project. Iterating over this object will yield results and resolve additional pages automatically.

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
NameDescription
request .recaptchaenterprise.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
TypeDescription
.recaptchaenterprise.KeyA key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.