Class Assessment (3.18.0)

public final class Assessment extends GeneratedMessageV3 implements AssessmentOrBuilder

A reCAPTCHA Enterprise assessment resource.

Protobuf type google.cloud.recaptchaenterprise.v1beta1.Assessment

Implements

AssessmentOrBuilder

Static Fields

ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER

public static final int ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_FIELD_NUMBER

public static final int EVENT_FIELD_NUMBER
Field Value
TypeDescription
int

FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER

public static final int FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER

public static final int PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER
Field Value
TypeDescription
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
TypeDescription
int

SCORE_FIELD_NUMBER

public static final int SCORE_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.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;

Returns
TypeDescription
AccountDefenderAssessment

The accountDefenderAssessment.

getAccountDefenderAssessmentOrBuilder()

public AccountDefenderAssessmentOrBuilder getAccountDefenderAssessmentOrBuilder()

Assessment returned by account defender when a hashed_account_id is provided.

.google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;

Returns
TypeDescription
AccountDefenderAssessmentOrBuilder

getDefaultInstanceForType()

public Assessment getDefaultInstanceForType()
Returns
TypeDescription
Assessment

getEvent()

public Event getEvent()

The event being assessed.

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

Returns
TypeDescription
Event

The event.

getEventOrBuilder()

public EventOrBuilder getEventOrBuilder()

The event being assessed.

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

Returns
TypeDescription
EventOrBuilder

getFraudPreventionAssessment()

public FraudPreventionAssessment getFraudPreventionAssessment()

Assessment returned by Fraud Prevention when TransactionData is provided.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;

Returns
TypeDescription
FraudPreventionAssessmentOrBuilder

getName()

public String getName()

Output only. The resource name for the Assessment in the format "projects/{project_number}/assessments/{assessment_id}".

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_number}/assessments/{assessment_id}".

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

getPasswordLeakVerification()

public PasswordLeakVerification getPasswordLeakVerification()

Information about the user's credentials used to check for leaks. This feature is part of the Early Access Program (EAP). Exercise caution, and do not deploy integrations based on this feature in a production environment.

.google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;

Returns
TypeDescription
PasswordLeakVerification

The passwordLeakVerification.

getPasswordLeakVerificationOrBuilder()

public PasswordLeakVerificationOrBuilder getPasswordLeakVerificationOrBuilder()

Information about the user's credentials used to check for leaks. This feature is part of the Early Access Program (EAP). Exercise caution, and do not deploy integrations based on this feature in a production environment.

.google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;

Returns
TypeDescription
PasswordLeakVerificationOrBuilder

getReasons(int index)

public Assessment.ClassificationReason getReasons(int index)

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
Assessment.ClassificationReason

The reasons at the given index.

getReasonsCount()

public int getReasonsCount()

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The count of reasons.

getReasonsList()

public List<Assessment.ClassificationReason> getReasonsList()

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<ClassificationReason>

A list containing the reasons.

getReasonsValue(int index)

public int getReasonsValue(int index)

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
int

The enum numeric value on the wire of reasons at the given index.

getReasonsValueList()

public List<Integer> getReasonsValueList()

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Integer>

A list containing the enum numeric values on the wire for reasons.

getScore()

public float getScore()

Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

float score = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTokenProperties()

public TokenProperties getTokenProperties()

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.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.v1beta1.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.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;

Returns
TypeDescription
boolean

Whether the accountDefenderAssessment field is set.

hasEvent()

public boolean hasEvent()

The event being assessed.

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

Returns
TypeDescription
boolean

Whether the event field is set.

hasFraudPreventionAssessment()

public boolean hasFraudPreventionAssessment()

Assessment returned by Fraud Prevention when TransactionData is provided.

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

Returns
TypeDescription
boolean

Whether the fraudPreventionAssessment field is set.

hasPasswordLeakVerification()

public boolean hasPasswordLeakVerification()

Information about the user's credentials used to check for leaks. This feature is part of the Early Access Program (EAP). Exercise caution, and do not deploy integrations based on this feature in a production environment.

.google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;

Returns
TypeDescription
boolean

Whether the passwordLeakVerification field is set.

hasTokenProperties()

public boolean hasTokenProperties()

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.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