Class Assessment.Builder (3.51.0)

public static final class Assessment.Builder extends GeneratedMessageV3.Builder<Assessment.Builder> implements AssessmentOrBuilder

A reCAPTCHA Enterprise assessment resource.

Protobuf type google.cloud.recaptchaenterprise.v1.Assessment

Implements

AssessmentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Assessment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Assessment.Builder
Overrides

build()

public Assessment build()
Returns
Type Description
Assessment

buildPartial()

public Assessment buildPartial()
Returns
Type Description
Assessment

clear()

public Assessment.Builder clear()
Returns
Type Description
Assessment.Builder
Overrides

clearAccountDefenderAssessment()

public Assessment.Builder clearAccountDefenderAssessment()

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
Type Description
Assessment.Builder

clearAccountVerification()

public Assessment.Builder clearAccountVerification()

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
Type Description
Assessment.Builder

clearAssessmentEnvironment()

public Assessment.Builder clearAssessmentEnvironment()

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
Type Description
Assessment.Builder

clearEvent()

public Assessment.Builder clearEvent()

Optional. The event being assessed.

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

Returns
Type Description
Assessment.Builder

clearField(Descriptors.FieldDescriptor field)

public Assessment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Assessment.Builder
Overrides

clearFirewallPolicyAssessment()

public Assessment.Builder clearFirewallPolicyAssessment()

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
Type Description
Assessment.Builder

clearFraudPreventionAssessment()

public Assessment.Builder clearFraudPreventionAssessment()

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
Type Description
Assessment.Builder

clearFraudSignals()

public Assessment.Builder clearFraudSignals()

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
Type Description
Assessment.Builder

clearName()

public Assessment.Builder clearName()

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
Type Description
Assessment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Assessment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Assessment.Builder
Overrides

clearPhoneFraudAssessment()

public Assessment.Builder clearPhoneFraudAssessment()

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
Type Description
Assessment.Builder

clearPrivatePasswordLeakVerification()

public Assessment.Builder clearPrivatePasswordLeakVerification()

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
Type Description
Assessment.Builder

clearRiskAnalysis()

public Assessment.Builder clearRiskAnalysis()

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
Type Description
Assessment.Builder

clearTokenProperties()

public Assessment.Builder clearTokenProperties()

Output only. Properties of the provided event token.

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

Returns
Type Description
Assessment.Builder

clone()

public Assessment.Builder clone()
Returns
Type Description
Assessment.Builder
Overrides

getAccountDefenderAssessment()

public 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
Type Description
AccountDefenderAssessment

The accountDefenderAssessment.

getAccountDefenderAssessmentBuilder()

public AccountDefenderAssessment.Builder getAccountDefenderAssessmentBuilder()

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
Type Description
AccountDefenderAssessment.Builder

getAccountDefenderAssessmentOrBuilder()

public 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];

Returns
Type Description
AccountDefenderAssessmentOrBuilder

getAccountVerification()

public 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
Type Description
AccountVerificationInfo

The accountVerification.

getAccountVerificationBuilder()

public AccountVerificationInfo.Builder getAccountVerificationBuilder()

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
Type Description
AccountVerificationInfo.Builder

getAccountVerificationOrBuilder()

public 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];

Returns
Type Description
AccountVerificationInfoOrBuilder

getAssessmentEnvironment()

public 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
Type Description
AssessmentEnvironment

The assessmentEnvironment.

getAssessmentEnvironmentBuilder()

public AssessmentEnvironment.Builder getAssessmentEnvironmentBuilder()

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
Type Description
AssessmentEnvironment.Builder

getAssessmentEnvironmentOrBuilder()

public 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];

Returns
Type Description
AssessmentEnvironmentOrBuilder

getDefaultInstanceForType()

public Assessment getDefaultInstanceForType()
Returns
Type Description
Assessment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEvent()

public Event getEvent()

Optional. The event being assessed.

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

Returns
Type Description
Event

The event.

getEventBuilder()

public Event.Builder getEventBuilder()

Optional. The event being assessed.

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

Returns
Type Description
Event.Builder

getEventOrBuilder()

public EventOrBuilder getEventOrBuilder()

Optional. The event being assessed.

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

Returns
Type Description
EventOrBuilder

getFirewallPolicyAssessment()

public 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
Type Description
FirewallPolicyAssessment

The firewallPolicyAssessment.

getFirewallPolicyAssessmentBuilder()

public FirewallPolicyAssessment.Builder getFirewallPolicyAssessmentBuilder()

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
Type Description
FirewallPolicyAssessment.Builder

getFirewallPolicyAssessmentOrBuilder()

public 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];

Returns
Type Description
FirewallPolicyAssessmentOrBuilder

getFraudPreventionAssessment()

public 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
Type Description
FraudPreventionAssessment

The fraudPreventionAssessment.

getFraudPreventionAssessmentBuilder()

public FraudPreventionAssessment.Builder getFraudPreventionAssessmentBuilder()

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
Type Description
FraudPreventionAssessment.Builder

getFraudPreventionAssessmentOrBuilder()

public 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];

Returns
Type Description
FraudPreventionAssessmentOrBuilder

getFraudSignals()

public 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
Type Description
FraudSignals

The fraudSignals.

getFraudSignalsBuilder()

public FraudSignals.Builder getFraudSignalsBuilder()

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
Type Description
FraudSignals.Builder

getFraudSignalsOrBuilder()

public 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];

Returns
Type Description
FraudSignalsOrBuilder

getName()

public 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
Type Description
String

The name.

getNameBytes()

public 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
Type Description
ByteString

The bytes for name.

getPhoneFraudAssessment()

public 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
Type Description
PhoneFraudAssessment

The phoneFraudAssessment.

getPhoneFraudAssessmentBuilder()

public PhoneFraudAssessment.Builder getPhoneFraudAssessmentBuilder()

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
Type Description
PhoneFraudAssessment.Builder

getPhoneFraudAssessmentOrBuilder()

public 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];

Returns
Type Description
PhoneFraudAssessmentOrBuilder

getPrivatePasswordLeakVerification()

public 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
Type Description
PrivatePasswordLeakVerification

The privatePasswordLeakVerification.

getPrivatePasswordLeakVerificationBuilder()

public PrivatePasswordLeakVerification.Builder getPrivatePasswordLeakVerificationBuilder()

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
Type Description
PrivatePasswordLeakVerification.Builder

getPrivatePasswordLeakVerificationOrBuilder()

public 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];

Returns
Type Description
PrivatePasswordLeakVerificationOrBuilder

getRiskAnalysis()

public 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
Type Description
RiskAnalysis

The riskAnalysis.

getRiskAnalysisBuilder()

public RiskAnalysis.Builder getRiskAnalysisBuilder()

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
Type Description
RiskAnalysis.Builder

getRiskAnalysisOrBuilder()

public 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];

Returns
Type Description
RiskAnalysisOrBuilder

getTokenProperties()

public 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
Type Description
TokenProperties

The tokenProperties.

getTokenPropertiesBuilder()

public TokenProperties.Builder getTokenPropertiesBuilder()

Output only. Properties of the provided event token.

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

Returns
Type Description
TokenProperties.Builder

getTokenPropertiesOrBuilder()

public TokenPropertiesOrBuilder getTokenPropertiesOrBuilder()

Output only. Properties of the provided event token.

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

Returns
Type Description
TokenPropertiesOrBuilder

hasAccountDefenderAssessment()

public 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
Type Description
boolean

Whether the accountDefenderAssessment field is set.

hasAccountVerification()

public 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
Type Description
boolean

Whether the accountVerification field is set.

hasAssessmentEnvironment()

public 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
Type Description
boolean

Whether the assessmentEnvironment field is set.

hasEvent()

public boolean hasEvent()

Optional. The event being assessed.

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

Returns
Type Description
boolean

Whether the event field is set.

hasFirewallPolicyAssessment()

public 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
Type Description
boolean

Whether the firewallPolicyAssessment field is set.

hasFraudPreventionAssessment()

public 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
Type Description
boolean

Whether the fraudPreventionAssessment field is set.

hasFraudSignals()

public 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
Type Description
boolean

Whether the fraudSignals field is set.

hasPhoneFraudAssessment()

public 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
Type Description
boolean

Whether the phoneFraudAssessment field is set.

hasPrivatePasswordLeakVerification()

public 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
Type Description
boolean

Whether the privatePasswordLeakVerification field is set.

hasRiskAnalysis()

public 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
Type Description
boolean

Whether the riskAnalysis field is set.

hasTokenProperties()

public 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
Type Description
boolean

Whether the tokenProperties field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccountDefenderAssessment(AccountDefenderAssessment value)

public Assessment.Builder mergeAccountDefenderAssessment(AccountDefenderAssessment value)

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];

Parameter
Name Description
value AccountDefenderAssessment
Returns
Type Description
Assessment.Builder

mergeAccountVerification(AccountVerificationInfo value)

public Assessment.Builder mergeAccountVerification(AccountVerificationInfo value)

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];

Parameter
Name Description
value AccountVerificationInfo
Returns
Type Description
Assessment.Builder

mergeAssessmentEnvironment(AssessmentEnvironment value)

public Assessment.Builder mergeAssessmentEnvironment(AssessmentEnvironment value)

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];

Parameter
Name Description
value AssessmentEnvironment
Returns
Type Description
Assessment.Builder

mergeEvent(Event value)

public Assessment.Builder mergeEvent(Event value)

Optional. The event being assessed.

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

Parameter
Name Description
value Event
Returns
Type Description
Assessment.Builder

mergeFirewallPolicyAssessment(FirewallPolicyAssessment value)

public Assessment.Builder mergeFirewallPolicyAssessment(FirewallPolicyAssessment value)

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];

Parameter
Name Description
value FirewallPolicyAssessment
Returns
Type Description
Assessment.Builder

mergeFraudPreventionAssessment(FraudPreventionAssessment value)

public Assessment.Builder mergeFraudPreventionAssessment(FraudPreventionAssessment value)

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];

Parameter
Name Description
value FraudPreventionAssessment
Returns
Type Description
Assessment.Builder

mergeFraudSignals(FraudSignals value)

public Assessment.Builder mergeFraudSignals(FraudSignals value)

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];

Parameter
Name Description
value FraudSignals
Returns
Type Description
Assessment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Assessment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Assessment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Assessment.Builder
Overrides

mergeFrom(Assessment other)

public Assessment.Builder mergeFrom(Assessment other)
Parameter
Name Description
other Assessment
Returns
Type Description
Assessment.Builder

mergePhoneFraudAssessment(PhoneFraudAssessment value)

public Assessment.Builder mergePhoneFraudAssessment(PhoneFraudAssessment value)

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];

Parameter
Name Description
value PhoneFraudAssessment
Returns
Type Description
Assessment.Builder

mergePrivatePasswordLeakVerification(PrivatePasswordLeakVerification value)

public Assessment.Builder mergePrivatePasswordLeakVerification(PrivatePasswordLeakVerification value)

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];

Parameter
Name Description
value PrivatePasswordLeakVerification
Returns
Type Description
Assessment.Builder

mergeRiskAnalysis(RiskAnalysis value)

public Assessment.Builder mergeRiskAnalysis(RiskAnalysis value)

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];

Parameter
Name Description
value RiskAnalysis
Returns
Type Description
Assessment.Builder

mergeTokenProperties(TokenProperties value)

public Assessment.Builder mergeTokenProperties(TokenProperties value)

Output only. Properties of the provided event token.

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

Parameter
Name Description
value TokenProperties
Returns
Type Description
Assessment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Assessment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Assessment.Builder
Overrides

setAccountDefenderAssessment(AccountDefenderAssessment value)

public Assessment.Builder setAccountDefenderAssessment(AccountDefenderAssessment value)

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];

Parameter
Name Description
value AccountDefenderAssessment
Returns
Type Description
Assessment.Builder

setAccountDefenderAssessment(AccountDefenderAssessment.Builder builderForValue)

public Assessment.Builder setAccountDefenderAssessment(AccountDefenderAssessment.Builder builderForValue)

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];

Parameter
Name Description
builderForValue AccountDefenderAssessment.Builder
Returns
Type Description
Assessment.Builder

setAccountVerification(AccountVerificationInfo value)

public Assessment.Builder setAccountVerification(AccountVerificationInfo value)

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];

Parameter
Name Description
value AccountVerificationInfo
Returns
Type Description
Assessment.Builder

setAccountVerification(AccountVerificationInfo.Builder builderForValue)

public Assessment.Builder setAccountVerification(AccountVerificationInfo.Builder builderForValue)

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];

Parameter
Name Description
builderForValue AccountVerificationInfo.Builder
Returns
Type Description
Assessment.Builder

setAssessmentEnvironment(AssessmentEnvironment value)

public Assessment.Builder setAssessmentEnvironment(AssessmentEnvironment value)

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];

Parameter
Name Description
value AssessmentEnvironment
Returns
Type Description
Assessment.Builder

setAssessmentEnvironment(AssessmentEnvironment.Builder builderForValue)

public Assessment.Builder setAssessmentEnvironment(AssessmentEnvironment.Builder builderForValue)

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];

Parameter
Name Description
builderForValue AssessmentEnvironment.Builder
Returns
Type Description
Assessment.Builder

setEvent(Event value)

public Assessment.Builder setEvent(Event value)

Optional. The event being assessed.

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

Parameter
Name Description
value Event
Returns
Type Description
Assessment.Builder

setEvent(Event.Builder builderForValue)

public Assessment.Builder setEvent(Event.Builder builderForValue)

Optional. The event being assessed.

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

Parameter
Name Description
builderForValue Event.Builder
Returns
Type Description
Assessment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Assessment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Assessment.Builder
Overrides

setFirewallPolicyAssessment(FirewallPolicyAssessment value)

public Assessment.Builder setFirewallPolicyAssessment(FirewallPolicyAssessment value)

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];

Parameter
Name Description
value FirewallPolicyAssessment
Returns
Type Description
Assessment.Builder

setFirewallPolicyAssessment(FirewallPolicyAssessment.Builder builderForValue)

public Assessment.Builder setFirewallPolicyAssessment(FirewallPolicyAssessment.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FirewallPolicyAssessment.Builder
Returns
Type Description
Assessment.Builder

setFraudPreventionAssessment(FraudPreventionAssessment value)

public Assessment.Builder setFraudPreventionAssessment(FraudPreventionAssessment value)

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];

Parameter
Name Description
value FraudPreventionAssessment
Returns
Type Description
Assessment.Builder

setFraudPreventionAssessment(FraudPreventionAssessment.Builder builderForValue)

public Assessment.Builder setFraudPreventionAssessment(FraudPreventionAssessment.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FraudPreventionAssessment.Builder
Returns
Type Description
Assessment.Builder

setFraudSignals(FraudSignals value)

public Assessment.Builder setFraudSignals(FraudSignals value)

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];

Parameter
Name Description
value FraudSignals
Returns
Type Description
Assessment.Builder

setFraudSignals(FraudSignals.Builder builderForValue)

public Assessment.Builder setFraudSignals(FraudSignals.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FraudSignals.Builder
Returns
Type Description
Assessment.Builder

setName(String value)

public Assessment.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Assessment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Assessment.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Assessment.Builder

This builder for chaining.

setPhoneFraudAssessment(PhoneFraudAssessment value)

public Assessment.Builder setPhoneFraudAssessment(PhoneFraudAssessment value)

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];

Parameter
Name Description
value PhoneFraudAssessment
Returns
Type Description
Assessment.Builder

setPhoneFraudAssessment(PhoneFraudAssessment.Builder builderForValue)

public Assessment.Builder setPhoneFraudAssessment(PhoneFraudAssessment.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PhoneFraudAssessment.Builder
Returns
Type Description
Assessment.Builder

setPrivatePasswordLeakVerification(PrivatePasswordLeakVerification value)

public Assessment.Builder setPrivatePasswordLeakVerification(PrivatePasswordLeakVerification value)

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];

Parameter
Name Description
value PrivatePasswordLeakVerification
Returns
Type Description
Assessment.Builder

setPrivatePasswordLeakVerification(PrivatePasswordLeakVerification.Builder builderForValue)

public Assessment.Builder setPrivatePasswordLeakVerification(PrivatePasswordLeakVerification.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PrivatePasswordLeakVerification.Builder
Returns
Type Description
Assessment.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Assessment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Assessment.Builder
Overrides

setRiskAnalysis(RiskAnalysis value)

public Assessment.Builder setRiskAnalysis(RiskAnalysis value)

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];

Parameter
Name Description
value RiskAnalysis
Returns
Type Description
Assessment.Builder

setRiskAnalysis(RiskAnalysis.Builder builderForValue)

public Assessment.Builder setRiskAnalysis(RiskAnalysis.Builder builderForValue)

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];

Parameter
Name Description
builderForValue RiskAnalysis.Builder
Returns
Type Description
Assessment.Builder

setTokenProperties(TokenProperties value)

public Assessment.Builder setTokenProperties(TokenProperties value)

Output only. Properties of the provided event token.

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

Parameter
Name Description
value TokenProperties
Returns
Type Description
Assessment.Builder

setTokenProperties(TokenProperties.Builder builderForValue)

public Assessment.Builder setTokenProperties(TokenProperties.Builder builderForValue)

Output only. Properties of the provided event token.

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

Parameter
Name Description
builderForValue TokenProperties.Builder
Returns
Type Description
Assessment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Assessment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Assessment.Builder
Overrides