Class RiskAnalysis (3.52.0)

public final class RiskAnalysis extends GeneratedMessageV3 implements RiskAnalysisOrBuilder

Risk analysis result for an event.

Protobuf type google.cloud.recaptchaenterprise.v1.RiskAnalysis

Static Fields

CHALLENGE_FIELD_NUMBER

public static final int CHALLENGE_FIELD_NUMBER
Field Value
Type Description
int

EXTENDED_VERDICT_REASONS_FIELD_NUMBER

public static final int EXTENDED_VERDICT_REASONS_FIELD_NUMBER
Field Value
Type Description
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
Type Description
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RiskAnalysis getDefaultInstance()
Returns
Type Description
RiskAnalysis

getDescriptor()

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

newBuilder()

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

newBuilder(RiskAnalysis prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChallenge()

public RiskAnalysis.Challenge getChallenge()

Output only. Challenge information for SCORE_AND_CHALLENGE and INVISIBLE keys

.google.cloud.recaptchaenterprise.v1.RiskAnalysis.Challenge challenge = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RiskAnalysis.Challenge

The challenge.

getChallengeValue()

public int getChallengeValue()

Output only. Challenge information for SCORE_AND_CHALLENGE and INVISIBLE keys

.google.cloud.recaptchaenterprise.v1.RiskAnalysis.Challenge challenge = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for challenge.

getDefaultInstanceForType()

public RiskAnalysis getDefaultInstanceForType()
Returns
Type Description
RiskAnalysis

getExtendedVerdictReasons(int index)

public String getExtendedVerdictReasons(int index)

Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.

repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The extendedVerdictReasons at the given index.

getExtendedVerdictReasonsBytes(int index)

public ByteString getExtendedVerdictReasonsBytes(int index)

Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.

repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the extendedVerdictReasons at the given index.

getExtendedVerdictReasonsCount()

public int getExtendedVerdictReasonsCount()

Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.

repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of extendedVerdictReasons.

getExtendedVerdictReasonsList()

public ProtocolStringList getExtendedVerdictReasonsList()

Output only. Extended verdict reasons to be used for experimentation only. The set of possible reasons is subject to change.

repeated string extended_verdict_reasons = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the extendedVerdictReasons.

getParserForType()

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

getReasons(int index)

public RiskAnalysis.ClassificationReason getReasons(int index)

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
RiskAnalysis.ClassificationReason

The reasons at the given index.

getReasonsCount()

public int getReasonsCount()

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of reasons.

getReasonsList()

public List<RiskAnalysis.ClassificationReason> getReasonsList()

Output only. Reasons contributing to the risk analysis verdict.

repeated .google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
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.v1.RiskAnalysis.ClassificationReason reasons = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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 = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 RiskAnalysis.Builder newBuilderForType()
Returns
Type Description
RiskAnalysis.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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