Class RiskAnalysis.Builder (3.80.0)

public static final class RiskAnalysis.Builder extends GeneratedMessage.Builder<RiskAnalysis.Builder> implements RiskAnalysisOrBuilder

Risk analysis result for an event.

Protobuf type google.cloud.recaptchaenterprise.v1.RiskAnalysis

Static Methods

getDescriptor()

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

Methods

addAllExtendedVerdictReasons(Iterable<String> values)

public RiskAnalysis.Builder addAllExtendedVerdictReasons(Iterable<String> values)

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
values Iterable<String>

The extendedVerdictReasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addAllReasons(Iterable<? extends RiskAnalysis.ClassificationReason> values)

public RiskAnalysis.Builder addAllReasons(Iterable<? extends RiskAnalysis.ClassificationReason> values)

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
values Iterable<? extends com.google.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason>

The reasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addAllReasonsValue(Iterable<Integer> values)

public RiskAnalysis.Builder addAllReasonsValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for reasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addAllVerifiedBots(Iterable<? extends Bot> values)

public RiskAnalysis.Builder addAllVerifiedBots(Iterable<? extends Bot> values)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.recaptchaenterprise.v1.Bot>
Returns
Type Description
RiskAnalysis.Builder

addExtendedVerdictReasons(String value)

public RiskAnalysis.Builder addExtendedVerdictReasons(String value)

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
value String

The extendedVerdictReasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addExtendedVerdictReasonsBytes(ByteString value)

public RiskAnalysis.Builder addExtendedVerdictReasonsBytes(ByteString value)

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
value ByteString

The bytes of the extendedVerdictReasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addReasons(RiskAnalysis.ClassificationReason value)

public RiskAnalysis.Builder addReasons(RiskAnalysis.ClassificationReason value)

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
value RiskAnalysis.ClassificationReason

The reasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addReasonsValue(int value)

public RiskAnalysis.Builder addReasonsValue(int value)

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
value int

The enum numeric value on the wire for reasons to add.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

addVerifiedBots(Bot value)

public RiskAnalysis.Builder addVerifiedBots(Bot value)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Bot
Returns
Type Description
RiskAnalysis.Builder

addVerifiedBots(Bot.Builder builderForValue)

public RiskAnalysis.Builder addVerifiedBots(Bot.Builder builderForValue)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

addVerifiedBots(int index, Bot value)

public RiskAnalysis.Builder addVerifiedBots(int index, Bot value)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Bot
Returns
Type Description
RiskAnalysis.Builder

addVerifiedBots(int index, Bot.Builder builderForValue)

public RiskAnalysis.Builder addVerifiedBots(int index, Bot.Builder builderForValue)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Bot.Builder
Returns
Type Description
RiskAnalysis.Builder

addVerifiedBotsBuilder()

public Bot.Builder addVerifiedBotsBuilder()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Bot.Builder

addVerifiedBotsBuilder(int index)

public Bot.Builder addVerifiedBotsBuilder(int index)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Bot.Builder

build()

public RiskAnalysis build()
Returns
Type Description
RiskAnalysis

buildPartial()

public RiskAnalysis buildPartial()
Returns
Type Description
RiskAnalysis

clear()

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

clearChallenge()

public RiskAnalysis.Builder clearChallenge()

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

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

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

clearExtendedVerdictReasons()

public RiskAnalysis.Builder clearExtendedVerdictReasons()

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

This builder for chaining.

clearReasons()

public RiskAnalysis.Builder clearReasons()

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

This builder for chaining.

clearScore()

public RiskAnalysis.Builder clearScore()

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

This builder for chaining.

clearVerifiedBots()

public RiskAnalysis.Builder clearVerifiedBots()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RiskAnalysis.Builder

getChallenge()

public RiskAnalysis.Challenge getChallenge()

Output only. Challenge information for POLICY_BASED_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 POLICY_BASED_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

getDescriptorForType()

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

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.

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.

getVerifiedBots(int index)

public Bot getVerifiedBots(int index)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Bot

getVerifiedBotsBuilder(int index)

public Bot.Builder getVerifiedBotsBuilder(int index)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Bot.Builder

getVerifiedBotsBuilderList()

public List<Bot.Builder> getVerifiedBotsBuilderList()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getVerifiedBotsCount()

public int getVerifiedBotsCount()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getVerifiedBotsList()

public List<Bot> getVerifiedBotsList()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Bot>

getVerifiedBotsOrBuilder(int index)

public BotOrBuilder getVerifiedBotsOrBuilder(int index)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
BotOrBuilder

getVerifiedBotsOrBuilderList()

public List<? extends BotOrBuilder> getVerifiedBotsOrBuilderList()

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.recaptchaenterprise.v1.BotOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(RiskAnalysis other)

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

removeVerifiedBots(int index)

public RiskAnalysis.Builder removeVerifiedBots(int index)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
RiskAnalysis.Builder

setChallenge(RiskAnalysis.Challenge value)

public RiskAnalysis.Builder setChallenge(RiskAnalysis.Challenge value)

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

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

Parameter
Name Description
value RiskAnalysis.Challenge

The challenge to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setChallengeValue(int value)

public RiskAnalysis.Builder setChallengeValue(int value)

Output only. Challenge information for POLICY_BASED_CHALLENGE and INVISIBLE keys.

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

Parameter
Name Description
value int

The enum numeric value on the wire for challenge to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setExtendedVerdictReasons(int index, String value)

public RiskAnalysis.Builder setExtendedVerdictReasons(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.

value String

The extendedVerdictReasons to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setReasons(int index, RiskAnalysis.ClassificationReason value)

public RiskAnalysis.Builder setReasons(int index, RiskAnalysis.ClassificationReason value)

Output only. Reasons contributing to the risk analysis verdict.

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

Parameters
Name Description
index int

The index to set the value at.

value RiskAnalysis.ClassificationReason

The reasons to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setReasonsValue(int index, int value)

public RiskAnalysis.Builder setReasonsValue(int index, int value)

Output only. Reasons contributing to the risk analysis verdict.

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

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for reasons to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setScore(float value)

public RiskAnalysis.Builder setScore(float value)

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

Parameter
Name Description
value float

The score to set.

Returns
Type Description
RiskAnalysis.Builder

This builder for chaining.

setVerifiedBots(int index, Bot value)

public RiskAnalysis.Builder setVerifiedBots(int index, Bot value)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Bot
Returns
Type Description
RiskAnalysis.Builder

setVerifiedBots(int index, Bot.Builder builderForValue)

public RiskAnalysis.Builder setVerifiedBots(int index, Bot.Builder builderForValue)

Output only. Bots with identities that have been verified by reCAPTCHA and detected in the event.

repeated .google.cloud.recaptchaenterprise.v1.Bot verified_bots = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Bot.Builder
Returns
Type Description
RiskAnalysis.Builder