Class Assessment (3.26.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
TypeDescription
int

ACCOUNT_VERIFICATION_FIELD_NUMBER

public static final int ACCOUNT_VERIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
TypeDescription
int

FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER

public static final int FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER
Field Value
TypeDescription
int

FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER

public static final int FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER
Field Value
TypeDescription
int

FRAUD_SIGNALS_FIELD_NUMBER

public static final int FRAUD_SIGNALS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER

public static final int PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

RISK_ANALYSIS_FIELD_NUMBER

public static final int RISK_ANALYSIS_FIELD_NUMBER
Field Value
TypeDescription
int

TOKEN_PROPERTIES_FIELD_NUMBER

public static final int TOKEN_PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Assessment getDefaultInstance()
Returns
TypeDescription
Assessment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Assessment.Builder newBuilder()
Returns
TypeDescription
Assessment.Builder

newBuilder(Assessment prototype)

public static Assessment.Builder newBuilder(Assessment prototype)
Parameter
NameDescription
prototypeAssessment
Returns
TypeDescription
Assessment.Builder

parseDelimitedFrom(InputStream input)

public static Assessment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Assessment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Assessment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Assessment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Assessment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Assessment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Assessment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Assessment> parser()
Returns
TypeDescription
Parser<Assessment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccountDefenderAssessment()

public AccountDefenderAssessment getAccountDefenderAssessment()

Assessment returned by account defender when a hashed_account_id is provided.

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6;

Returns
TypeDescription
AccountDefenderAssessment

The accountDefenderAssessment.

getAccountDefenderAssessmentOrBuilder()

public AccountDefenderAssessmentOrBuilder getAccountDefenderAssessmentOrBuilder()

Assessment returned by account defender when a hashed_account_id is provided.

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6;

Returns
TypeDescription
AccountDefenderAssessmentOrBuilder

getAccountVerification()

public AccountVerificationInfo getAccountVerification()

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;

Returns
TypeDescription
AccountVerificationInfo

The accountVerification.

getAccountVerificationOrBuilder()

public AccountVerificationInfoOrBuilder getAccountVerificationOrBuilder()

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;

Returns
TypeDescription
AccountVerificationInfoOrBuilder

getDefaultInstanceForType()

public Assessment getDefaultInstanceForType()
Returns
TypeDescription
Assessment

getEvent()

public Event getEvent()

The event being assessed.

.google.cloud.recaptchaenterprise.v1.Event event = 2;

Returns
TypeDescription
Event

The event.

getEventOrBuilder()

public EventOrBuilder getEventOrBuilder()

The event being assessed.

.google.cloud.recaptchaenterprise.v1.Event event = 2;

Returns
TypeDescription
EventOrBuilder

getFirewallPolicyAssessment()

public FirewallPolicyAssessment getFirewallPolicyAssessment()

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;

Returns
TypeDescription
FirewallPolicyAssessment

The firewallPolicyAssessment.

getFirewallPolicyAssessmentOrBuilder()

public FirewallPolicyAssessmentOrBuilder getFirewallPolicyAssessmentOrBuilder()

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;

Returns
TypeDescription
FirewallPolicyAssessmentOrBuilder

getFraudPreventionAssessment()

public FraudPreventionAssessment getFraudPreventionAssessment()

Assessment returned by Fraud Prevention when TransactionData is provided.

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11;

Returns
TypeDescription
FraudPreventionAssessment

The fraudPreventionAssessment.

getFraudPreventionAssessmentOrBuilder()

public FraudPreventionAssessmentOrBuilder getFraudPreventionAssessmentOrBuilder()

Assessment returned by Fraud Prevention when TransactionData is provided.

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
FraudSignalsOrBuilder

getName()

public String getName()

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

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Assessment> getParserForType()
Returns
TypeDescription
Parser<Assessment>
Overrides

getPrivatePasswordLeakVerification()

public PrivatePasswordLeakVerification getPrivatePasswordLeakVerification()

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;

Returns
TypeDescription
PrivatePasswordLeakVerification

The privatePasswordLeakVerification.

getPrivatePasswordLeakVerificationOrBuilder()

public PrivatePasswordLeakVerificationOrBuilder getPrivatePasswordLeakVerificationOrBuilder()

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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RiskAnalysisOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TokenPropertiesOrBuilder

hasAccountDefenderAssessment()

public boolean hasAccountDefenderAssessment()

Assessment returned by account defender when a hashed_account_id is provided.

.google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6;

Returns
TypeDescription
boolean

Whether the accountDefenderAssessment field is set.

hasAccountVerification()

public boolean hasAccountVerification()

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;

Returns
TypeDescription
boolean

Whether the accountVerification field is set.

hasEvent()

public boolean hasEvent()

The event being assessed.

.google.cloud.recaptchaenterprise.v1.Event event = 2;

Returns
TypeDescription
boolean

Whether the event field is set.

hasFirewallPolicyAssessment()

public boolean hasFirewallPolicyAssessment()

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;

Returns
TypeDescription
boolean

Whether the firewallPolicyAssessment field is set.

hasFraudPreventionAssessment()

public boolean hasFraudPreventionAssessment()

Assessment returned by Fraud Prevention when TransactionData is provided.

.google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the fraudSignals field is set.

hasPrivatePasswordLeakVerification()

public boolean hasPrivatePasswordLeakVerification()

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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the tokenProperties field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Assessment.Builder newBuilderForType()
Returns
TypeDescription
Assessment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Assessment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Assessment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Assessment.Builder toBuilder()
Returns
TypeDescription
Assessment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException