Represents a RecaptchaEnterpriseService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServicePackage
@google-cloud/recaptcha-enterpriseConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new RecaptchaEnterpriseService service.
Parameters | |
---|---|
Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Methods
annotateAssessment(request, callback)
public annotateAssessment(request: google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessmentCallback): void;
Calls AnnotateAssessment.
Parameters | |
---|---|
Name | Description |
request |
IAnnotateAssessmentRequest
AnnotateAssessmentRequest message or plain object |
callback |
AnnotateAssessmentCallback
Node-style callback called with the error, if any, and AnnotateAssessmentResponse |
Returns | |
---|---|
Type | Description |
void |
annotateAssessment(request)
public annotateAssessment(request: google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest): Promise<google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse>;
Calls AnnotateAssessment.
Parameter | |
---|---|
Name | Description |
request |
IAnnotateAssessmentRequest
AnnotateAssessmentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse> | Promise |
create(rpcImpl, requestDelimited, responseDelimited)
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RecaptchaEnterpriseService;
Creates new RecaptchaEnterpriseService service using the specified rpc implementation.
Parameters | |
---|---|
Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Returns | |
---|---|
Type | Description |
RecaptchaEnterpriseService | RPC service. Useful where requests and/or responses are streamed. |
createAssessment(request, callback)
public createAssessment(request: google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessmentCallback): void;
Calls CreateAssessment.
Parameters | |
---|---|
Name | Description |
request |
ICreateAssessmentRequest
CreateAssessmentRequest message or plain object |
callback |
CreateAssessmentCallback
Node-style callback called with the error, if any, and Assessment |
Returns | |
---|---|
Type | Description |
void |
createAssessment(request)
public createAssessment(request: google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest): Promise<google.cloud.recaptchaenterprise.v1.Assessment>;
Calls CreateAssessment.
Parameter | |
---|---|
Name | Description |
request |
ICreateAssessmentRequest
CreateAssessmentRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Assessment> | Promise |
createFirewallPolicy(request, callback)
public createFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.ICreateFirewallPolicyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateFirewallPolicyCallback): void;
Calls CreateFirewallPolicy.
Parameters | |
---|---|
Name | Description |
request |
ICreateFirewallPolicyRequest
CreateFirewallPolicyRequest message or plain object |
callback |
CreateFirewallPolicyCallback
Node-style callback called with the error, if any, and FirewallPolicy |
Returns | |
---|---|
Type | Description |
void |
createFirewallPolicy(request)
public createFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.ICreateFirewallPolicyRequest): Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy>;
Calls CreateFirewallPolicy.
Parameter | |
---|---|
Name | Description |
request |
ICreateFirewallPolicyRequest
CreateFirewallPolicyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy> | Promise |
createKey(request, callback)
public createKey(request: google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKeyCallback): void;
Calls CreateKey.
Parameters | |
---|---|
Name | Description |
request |
ICreateKeyRequest
CreateKeyRequest message or plain object |
callback |
CreateKeyCallback
Node-style callback called with the error, if any, and Key |
Returns | |
---|---|
Type | Description |
void |
createKey(request)
public createKey(request: google.cloud.recaptchaenterprise.v1.ICreateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.Key>;
Calls CreateKey.
Parameter | |
---|---|
Name | Description |
request |
ICreateKeyRequest
CreateKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Key> | Promise |
deleteFirewallPolicy(request, callback)
public deleteFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IDeleteFirewallPolicyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteFirewallPolicyCallback): void;
Calls DeleteFirewallPolicy.
Parameters | |
---|---|
Name | Description |
request |
IDeleteFirewallPolicyRequest
DeleteFirewallPolicyRequest message or plain object |
callback |
DeleteFirewallPolicyCallback
Node-style callback called with the error, if any, and Empty |
Returns | |
---|---|
Type | Description |
void |
deleteFirewallPolicy(request)
public deleteFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IDeleteFirewallPolicyRequest): Promise<google.protobuf.Empty>;
Calls DeleteFirewallPolicy.
Parameter | |
---|---|
Name | Description |
request |
IDeleteFirewallPolicyRequest
DeleteFirewallPolicyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.protobuf.Empty> | Promise |
deleteKey(request, callback)
public deleteKey(request: google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKeyCallback): void;
Calls DeleteKey.
Parameters | |
---|---|
Name | Description |
request |
IDeleteKeyRequest
DeleteKeyRequest message or plain object |
callback |
DeleteKeyCallback
Node-style callback called with the error, if any, and Empty |
Returns | |
---|---|
Type | Description |
void |
deleteKey(request)
public deleteKey(request: google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest): Promise<google.protobuf.Empty>;
Calls DeleteKey.
Parameter | |
---|---|
Name | Description |
request |
IDeleteKeyRequest
DeleteKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.protobuf.Empty> | Promise |
getFirewallPolicy(request, callback)
public getFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IGetFirewallPolicyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetFirewallPolicyCallback): void;
Calls GetFirewallPolicy.
Parameters | |
---|---|
Name | Description |
request |
IGetFirewallPolicyRequest
GetFirewallPolicyRequest message or plain object |
callback |
GetFirewallPolicyCallback
Node-style callback called with the error, if any, and FirewallPolicy |
Returns | |
---|---|
Type | Description |
void |
getFirewallPolicy(request)
public getFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IGetFirewallPolicyRequest): Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy>;
Calls GetFirewallPolicy.
Parameter | |
---|---|
Name | Description |
request |
IGetFirewallPolicyRequest
GetFirewallPolicyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy> | Promise |
getKey(request, callback)
public getKey(request: google.cloud.recaptchaenterprise.v1.IGetKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKeyCallback): void;
Calls GetKey.
Parameters | |
---|---|
Name | Description |
request |
IGetKeyRequest
GetKeyRequest message or plain object |
callback |
GetKeyCallback
Node-style callback called with the error, if any, and Key |
Returns | |
---|---|
Type | Description |
void |
getKey(request)
public getKey(request: google.cloud.recaptchaenterprise.v1.IGetKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.Key>;
Calls GetKey.
Parameter | |
---|---|
Name | Description |
request |
IGetKeyRequest
GetKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Key> | Promise |
getMetrics(request, callback)
public getMetrics(request: google.cloud.recaptchaenterprise.v1.IGetMetricsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetricsCallback): void;
Calls GetMetrics.
Parameters | |
---|---|
Name | Description |
request |
IGetMetricsRequest
GetMetricsRequest message or plain object |
callback |
GetMetricsCallback
Node-style callback called with the error, if any, and Metrics |
Returns | |
---|---|
Type | Description |
void |
getMetrics(request)
public getMetrics(request: google.cloud.recaptchaenterprise.v1.IGetMetricsRequest): Promise<google.cloud.recaptchaenterprise.v1.Metrics>;
Calls GetMetrics.
Parameter | |
---|---|
Name | Description |
request |
IGetMetricsRequest
GetMetricsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Metrics> | Promise |
listFirewallPolicies(request, callback)
public listFirewallPolicies(request: google.cloud.recaptchaenterprise.v1.IListFirewallPoliciesRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListFirewallPoliciesCallback): void;
Calls ListFirewallPolicies.
Parameters | |
---|---|
Name | Description |
request |
IListFirewallPoliciesRequest
ListFirewallPoliciesRequest message or plain object |
callback |
ListFirewallPoliciesCallback
Node-style callback called with the error, if any, and ListFirewallPoliciesResponse |
Returns | |
---|---|
Type | Description |
void |
listFirewallPolicies(request)
public listFirewallPolicies(request: google.cloud.recaptchaenterprise.v1.IListFirewallPoliciesRequest): Promise<google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesResponse>;
Calls ListFirewallPolicies.
Parameter | |
---|---|
Name | Description |
request |
IListFirewallPoliciesRequest
ListFirewallPoliciesRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesResponse> | Promise |
listKeys(request, callback)
public listKeys(request: google.cloud.recaptchaenterprise.v1.IListKeysRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeysCallback): void;
Calls ListKeys.
Parameters | |
---|---|
Name | Description |
request |
IListKeysRequest
ListKeysRequest message or plain object |
callback |
ListKeysCallback
Node-style callback called with the error, if any, and ListKeysResponse |
Returns | |
---|---|
Type | Description |
void |
listKeys(request)
public listKeys(request: google.cloud.recaptchaenterprise.v1.IListKeysRequest): Promise<google.cloud.recaptchaenterprise.v1.ListKeysResponse>;
Calls ListKeys.
Parameter | |
---|---|
Name | Description |
request |
IListKeysRequest
ListKeysRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.ListKeysResponse> | Promise |
listRelatedAccountGroupMemberships(request, callback)
public listRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMembershipsCallback): void;
Calls ListRelatedAccountGroupMemberships.
Parameters | |
---|---|
Name | Description |
request |
IListRelatedAccountGroupMembershipsRequest
ListRelatedAccountGroupMembershipsRequest message or plain object |
callback |
ListRelatedAccountGroupMembershipsCallback
Node-style callback called with the error, if any, and ListRelatedAccountGroupMembershipsResponse |
Returns | |
---|---|
Type | Description |
void |
listRelatedAccountGroupMemberships(request)
public listRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest): Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse>;
Calls ListRelatedAccountGroupMemberships.
Parameter | |
---|---|
Name | Description |
request |
IListRelatedAccountGroupMembershipsRequest
ListRelatedAccountGroupMembershipsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse> | Promise |
listRelatedAccountGroups(request, callback)
public listRelatedAccountGroups(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupsCallback): void;
Calls ListRelatedAccountGroups.
Parameters | |
---|---|
Name | Description |
request |
IListRelatedAccountGroupsRequest
ListRelatedAccountGroupsRequest message or plain object |
callback |
ListRelatedAccountGroupsCallback
Node-style callback called with the error, if any, and ListRelatedAccountGroupsResponse |
Returns | |
---|---|
Type | Description |
void |
listRelatedAccountGroups(request)
public listRelatedAccountGroups(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest): Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse>;
Calls ListRelatedAccountGroups.
Parameter | |
---|---|
Name | Description |
request |
IListRelatedAccountGroupsRequest
ListRelatedAccountGroupsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse> | Promise |
migrateKey(request, callback)
public migrateKey(request: google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKeyCallback): void;
Calls MigrateKey.
Parameters | |
---|---|
Name | Description |
request |
IMigrateKeyRequest
MigrateKeyRequest message or plain object |
callback |
MigrateKeyCallback
Node-style callback called with the error, if any, and Key |
Returns | |
---|---|
Type | Description |
void |
migrateKey(request)
public migrateKey(request: google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.Key>;
Calls MigrateKey.
Parameter | |
---|---|
Name | Description |
request |
IMigrateKeyRequest
MigrateKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Key> | Promise |
retrieveLegacySecretKey(request, callback)
public retrieveLegacySecretKey(request: google.cloud.recaptchaenterprise.v1.IRetrieveLegacySecretKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKeyCallback): void;
Calls RetrieveLegacySecretKey.
Parameters | |
---|---|
Name | Description |
request |
IRetrieveLegacySecretKeyRequest
RetrieveLegacySecretKeyRequest message or plain object |
callback |
RetrieveLegacySecretKeyCallback
Node-style callback called with the error, if any, and RetrieveLegacySecretKeyResponse |
Returns | |
---|---|
Type | Description |
void |
retrieveLegacySecretKey(request)
public retrieveLegacySecretKey(request: google.cloud.recaptchaenterprise.v1.IRetrieveLegacySecretKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse>;
Calls RetrieveLegacySecretKey.
Parameter | |
---|---|
Name | Description |
request |
IRetrieveLegacySecretKeyRequest
RetrieveLegacySecretKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse> | Promise |
searchRelatedAccountGroupMemberships(request, callback)
public searchRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMembershipsCallback): void;
Calls SearchRelatedAccountGroupMemberships.
Parameters | |
---|---|
Name | Description |
request |
ISearchRelatedAccountGroupMembershipsRequest
SearchRelatedAccountGroupMembershipsRequest message or plain object |
callback |
SearchRelatedAccountGroupMembershipsCallback
Node-style callback called with the error, if any, and SearchRelatedAccountGroupMembershipsResponse |
Returns | |
---|---|
Type | Description |
void |
searchRelatedAccountGroupMemberships(request)
public searchRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest): Promise<google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse>;
Calls SearchRelatedAccountGroupMemberships.
Parameter | |
---|---|
Name | Description |
request |
ISearchRelatedAccountGroupMembershipsRequest
SearchRelatedAccountGroupMembershipsRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse> | Promise |
updateFirewallPolicy(request, callback)
public updateFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IUpdateFirewallPolicyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateFirewallPolicyCallback): void;
Calls UpdateFirewallPolicy.
Parameters | |
---|---|
Name | Description |
request |
IUpdateFirewallPolicyRequest
UpdateFirewallPolicyRequest message or plain object |
callback |
UpdateFirewallPolicyCallback
Node-style callback called with the error, if any, and FirewallPolicy |
Returns | |
---|---|
Type | Description |
void |
updateFirewallPolicy(request)
public updateFirewallPolicy(request: google.cloud.recaptchaenterprise.v1.IUpdateFirewallPolicyRequest): Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy>;
Calls UpdateFirewallPolicy.
Parameter | |
---|---|
Name | Description |
request |
IUpdateFirewallPolicyRequest
UpdateFirewallPolicyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.FirewallPolicy> | Promise |
updateKey(request, callback)
public updateKey(request: google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKeyCallback): void;
Calls UpdateKey.
Parameters | |
---|---|
Name | Description |
request |
IUpdateKeyRequest
UpdateKeyRequest message or plain object |
callback |
UpdateKeyCallback
Node-style callback called with the error, if any, and Key |
Returns | |
---|---|
Type | Description |
void |
updateKey(request)
public updateKey(request: google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.Key>;
Calls UpdateKey.
Parameter | |
---|---|
Name | Description |
request |
IUpdateKeyRequest
UpdateKeyRequest message or plain object |
Returns | |
---|---|
Type | Description |
Promise<google.cloud.recaptchaenterprise.v1.Key> | Promise |