Class Assessment (3.46.0)

public final class Assessment extends GeneratedMessageV3 implements AssessmentOrBuilder

A reCAPTCHA Enterprise assessment resource.

Protobuf type google.cloud.recaptchaenterprise.v1.Assessment

Implements

AssessmentOrBuilder

Static Fields

ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER

public static final int ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER
Field Value
Type Description
int

ACCOUNT_VERIFICATION_FIELD_NUMBER

public static final int ACCOUNT_VERIFICATION_FIELD_NUMBER
Field Value
Type Description
int

ASSESSMENT_ENVIRONMENT_FIELD_NUMBER

public static final int ASSESSMENT_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
Type Description
int

FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER

public static final int FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER
Field Value
Type Description
int

FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER

public static final int FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER
Field Value
Type Description
int

FRAUD_SIGNALS_FIELD_NUMBER

public static final int FRAUD_SIGNALS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PHONE_FRAUD_ASSESSMENT_FIELD_NUMBER

public static final int PHONE_FRAUD_ASSESSMENT_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER

public static final int PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER
Field Value
Type Description
int

RISK_ANALYSIS_FIELD_NUMBER

public static final int RISK_ANALYSIS_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_PROPERTIES_FIELD_NUMBER

public static final int TOKEN_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Assessment getDefaultInstance()
Returns
Type Description
Assessment

getDescriptor()

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

newBuilder()

public static Assessment.Builder newBuilder()
Returns
Type Description
Assessment.Builder

newBuilder(Assessment prototype)

public static Assessment.Builder newBuilder(Assessment prototype)
Parameter
Name Description
prototype Assessment
Returns
Type Description
Assessment.Builder

parseDelimitedFrom(InputStream input)

public static Assessment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Assessment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Assessment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Assessment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Assessment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Assessment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Assessment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Assessment> parser()
Returns
Type Description
Parser<Assessment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

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

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.

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.

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.

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.

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.

getParserForType()

public Parser<Assessment> getParserForType()
Returns
Type Description
Parser<Assessment>
Overrides

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.

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Assessment.Builder newBuilderForType()
Returns
Type Description
Assessment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Assessment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Assessment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Assessment.Builder toBuilder()
Returns
Type Description
Assessment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException