com.google.recaptchaenterprise.v1

Interface AssessmentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Assessment, Assessment.Builder

public interface AssessmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AccountDefenderAssessment	getAccountDefenderAssessment() Output only.
AccountDefenderAssessmentOrBuilder	getAccountDefenderAssessmentOrBuilder() Output only.
AccountVerificationInfo	getAccountVerification() Optional.
AccountVerificationInfoOrBuilder	getAccountVerificationOrBuilder() Optional.
AssessmentEnvironment	getAssessmentEnvironment() Optional.
AssessmentEnvironmentOrBuilder	getAssessmentEnvironmentOrBuilder() Optional.
Event	getEvent() Optional.
EventOrBuilder	getEventOrBuilder() Optional.
FirewallPolicyAssessment	getFirewallPolicyAssessment() Output only.
FirewallPolicyAssessmentOrBuilder	getFirewallPolicyAssessmentOrBuilder() Output only.
FraudPreventionAssessment	getFraudPreventionAssessment() Output only.
FraudPreventionAssessmentOrBuilder	getFraudPreventionAssessmentOrBuilder() Output only.
FraudSignals	getFraudSignals() Output only.
FraudSignalsOrBuilder	getFraudSignalsOrBuilder() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
PhoneFraudAssessment	getPhoneFraudAssessment() Output only.
PhoneFraudAssessmentOrBuilder	getPhoneFraudAssessmentOrBuilder() Output only.
PrivatePasswordLeakVerification	getPrivatePasswordLeakVerification() Optional.
PrivatePasswordLeakVerificationOrBuilder	getPrivatePasswordLeakVerificationOrBuilder() Optional.
RiskAnalysis	getRiskAnalysis() Output only.
RiskAnalysisOrBuilder	getRiskAnalysisOrBuilder() Output only.
TokenProperties	getTokenProperties() Output only.
TokenPropertiesOrBuilder	getTokenPropertiesOrBuilder() Output only.
boolean	hasAccountDefenderAssessment() Output only.
boolean	hasAccountVerification() Optional.
boolean	hasAssessmentEnvironment() Optional.
boolean	hasEvent() Optional.
boolean	hasFirewallPolicyAssessment() Output only.
boolean	hasFraudPreventionAssessment() Output only.
boolean	hasFraudSignals() Output only.
boolean	hasPhoneFraudAssessment() Output only.
boolean	hasPrivatePasswordLeakVerification() Optional.
boolean	hasRiskAnalysis() Output only.
boolean	hasTokenProperties() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Identifier. The resource name for the Assessment in the format
 `projects/{project}/assessments/{assessment}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Identifier. The resource name for the Assessment in the format
 `projects/{project}/assessments/{assessment}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

hasEvent

boolean hasEvent()

 Optional. The event being assessed.
 

.google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the event field is set.

getEvent

Event getEvent()

 Optional. The event being assessed.
 

.google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The event.

getEventOrBuilder

EventOrBuilder getEventOrBuilder()

 Optional. The event being assessed.
 

.google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];

hasRiskAnalysis

boolean hasRiskAnalysis()

 Output only. The risk analysis result for the event being assessed.
 

.google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the riskAnalysis field is set.

getRiskAnalysis

RiskAnalysis getRiskAnalysis()

 Output only. The risk analysis result for the event being assessed.
 

.google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The riskAnalysis.

getRiskAnalysisOrBuilder

RiskAnalysisOrBuilder getRiskAnalysisOrBuilder()

 Output only. The risk analysis result for the event being assessed.
 

.google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasTokenProperties

boolean hasTokenProperties()

 Output only. Properties of the provided event token.
 

.google.cloud.recaptchaenterprise.v1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the tokenProperties field is set.

getTokenProperties

TokenProperties getTokenProperties()

 Output only. Properties of the provided event token.
 

.google.cloud.recaptchaenterprise.v1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The tokenProperties.

getTokenPropertiesOrBuilder

TokenPropertiesOrBuilder getTokenPropertiesOrBuilder()

 Output only. Properties of the provided event token.
 

.google.cloud.recaptchaenterprise.v1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasAccountVerification

boolean hasAccountVerification()

 Optional. Account verification information for identity verification. The
 assessment event must include a token and site key to use this feature.
 

.google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the accountVerification field is set.

getAccountVerification

AccountVerificationInfo getAccountVerification()

 Optional. Account verification information for identity verification. The
 assessment event must include a token and site key to use this feature.
 

.google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The accountVerification.

getAccountVerificationOrBuilder

AccountVerificationInfoOrBuilder getAccountVerificationOrBuilder()

 Optional. Account verification information for identity verification. The
 assessment event must include a token and site key to use this feature.
 

.google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];

hasAccountDefenderAssessment

boolean hasAccountDefenderAssessment()

 Output only. Assessment returned by account defender when an account
 identifier is provided.
 

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the accountDefenderAssessment field is set.

getAccountDefenderAssessment

AccountDefenderAssessment getAccountDefenderAssessment()

 Output only. Assessment returned by account defender when an account
 identifier is provided.
 

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The accountDefenderAssessment.

getAccountDefenderAssessmentOrBuilder

AccountDefenderAssessmentOrBuilder getAccountDefenderAssessmentOrBuilder()

 Output only. Assessment returned by account defender when an account
 identifier is provided.
 

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasPrivatePasswordLeakVerification

boolean hasPrivatePasswordLeakVerification()

 Optional. The private password leak verification field contains the
 parameters that are used to to check for leaks privately without sharing
 user credentials.
 

.google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the privatePasswordLeakVerification field is set.

getPrivatePasswordLeakVerification

PrivatePasswordLeakVerification getPrivatePasswordLeakVerification()

 Optional. The private password leak verification field contains the
 parameters that are used to to check for leaks privately without sharing
 user credentials.
 

.google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The privatePasswordLeakVerification.

getPrivatePasswordLeakVerificationOrBuilder

PrivatePasswordLeakVerificationOrBuilder getPrivatePasswordLeakVerificationOrBuilder()

 Optional. The private password leak verification field contains the
 parameters that are used to to check for leaks privately without sharing
 user credentials.
 

.google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];

hasFirewallPolicyAssessment

boolean hasFirewallPolicyAssessment()

 Output only. Assessment returned when firewall policies belonging to the
 project are evaluated using the field firewall_policy_evaluation.
 

.google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the firewallPolicyAssessment field is set.

getFirewallPolicyAssessment

FirewallPolicyAssessment getFirewallPolicyAssessment()

 Output only. Assessment returned when firewall policies belonging to the
 project are evaluated using the field firewall_policy_evaluation.
 

.google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The firewallPolicyAssessment.

getFirewallPolicyAssessmentOrBuilder

FirewallPolicyAssessmentOrBuilder getFirewallPolicyAssessmentOrBuilder()

 Output only. Assessment returned when firewall policies belonging to the
 project are evaluated using the field firewall_policy_evaluation.
 

.google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasFraudPreventionAssessment

boolean hasFraudPreventionAssessment()

 Output only. Assessment returned by Fraud Prevention when TransactionData
 is provided.
 

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the fraudPreventionAssessment field is set.

getFraudPreventionAssessment

FraudPreventionAssessment getFraudPreventionAssessment()

 Output only. Assessment returned by Fraud Prevention when TransactionData
 is provided.
 

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The fraudPreventionAssessment.

getFraudPreventionAssessmentOrBuilder

FraudPreventionAssessmentOrBuilder getFraudPreventionAssessmentOrBuilder()

 Output only. Assessment returned by Fraud Prevention when TransactionData
 is provided.
 

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasFraudSignals

boolean hasFraudSignals()

 Output only. Fraud Signals specific to the users involved in a payment
 transaction.
 

.google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the fraudSignals field is set.

getFraudSignals

FraudSignals getFraudSignals()

 Output only. Fraud Signals specific to the users involved in a payment
 transaction.
 

.google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The fraudSignals.

getFraudSignalsOrBuilder

FraudSignalsOrBuilder getFraudSignalsOrBuilder()

 Output only. Fraud Signals specific to the users involved in a payment
 transaction.
 

.google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasPhoneFraudAssessment

boolean hasPhoneFraudAssessment()

 Output only. Assessment returned when a site key, a token, and a phone
 number as `user_id` are provided. Account defender and SMS toll fraud
 protection need to be enabled.
 

.google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the phoneFraudAssessment field is set.

getPhoneFraudAssessment

PhoneFraudAssessment getPhoneFraudAssessment()

 Output only. Assessment returned when a site key, a token, and a phone
 number as `user_id` are provided. Account defender and SMS toll fraud
 protection need to be enabled.
 

.google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The phoneFraudAssessment.

getPhoneFraudAssessmentOrBuilder

PhoneFraudAssessmentOrBuilder getPhoneFraudAssessmentOrBuilder()

 Output only. Assessment returned when a site key, a token, and a phone
 number as `user_id` are provided. Account defender and SMS toll fraud
 protection need to be enabled.
 

.google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasAssessmentEnvironment

boolean hasAssessmentEnvironment()

 Optional. The environment creating the assessment. This describes your
 environment (the system invoking CreateAssessment), NOT the environment of
 your user.
 

.google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the assessmentEnvironment field is set.

getAssessmentEnvironment

AssessmentEnvironment getAssessmentEnvironment()

 Optional. The environment creating the assessment. This describes your
 environment (the system invoking CreateAssessment), NOT the environment of
 your user.
 

.google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The assessmentEnvironment.

getAssessmentEnvironmentOrBuilder

AssessmentEnvironmentOrBuilder getAssessmentEnvironmentOrBuilder()

 Optional. The environment creating the assessment. This describes your
 environment (the system invoking CreateAssessment), NOT the environment of
 your user.
 

.google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];