Class Assessment.Builder (3.3.0)

public static final class Assessment.Builder extends GeneratedMessageV3.Builder<Assessment.Builder> implements AssessmentOrBuilder

A recaptcha assessment resource.

Protobuf type google.cloud.recaptchaenterprise.v1beta1.Assessment

Implements

AssessmentOrBuilder

Static Methods

getDescriptor()

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

Methods

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

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

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
valuesIterable<? extends com.google.recaptchaenterprise.v1beta1.Assessment.ClassificationReason>

The reasons to add.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

addAllReasonsValue(Iterable<Integer> values)

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

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
valuesIterable<Integer>

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

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

addReasons(Assessment.ClassificationReason value)

public Assessment.Builder addReasons(Assessment.ClassificationReason value)

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
valueAssessment.ClassificationReason

The reasons to add.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

addReasonsValue(int value)

public Assessment.Builder addReasonsValue(int value)

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
valueint

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

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Assessment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Assessment.Builder
Overrides

build()

public Assessment build()
Returns
TypeDescription
Assessment

buildPartial()

public Assessment buildPartial()
Returns
TypeDescription
Assessment

clear()

public Assessment.Builder clear()
Returns
TypeDescription
Assessment.Builder
Overrides

clearAccountDefenderAssessment()

public Assessment.Builder clearAccountDefenderAssessment()

Assessment returned by Account Defender when a hashed_account_id is provided.

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

Returns
TypeDescription
Assessment.Builder

clearEvent()

public Assessment.Builder clearEvent()

The event being assessed.

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

Returns
TypeDescription
Assessment.Builder

clearField(Descriptors.FieldDescriptor field)

public Assessment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Assessment.Builder
Overrides

clearName()

public Assessment.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Assessment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Assessment.Builder
Overrides

clearPasswordLeakVerification()

public Assessment.Builder clearPasswordLeakVerification()

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

clearReasons()

public Assessment.Builder clearReasons()

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

This builder for chaining.

clearScore()

public Assessment.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 = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

clearTokenProperties()

public Assessment.Builder clearTokenProperties()

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Assessment.Builder

clone()

public Assessment.Builder clone()
Returns
TypeDescription
Assessment.Builder
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.

getAccountDefenderAssessmentBuilder()

public AccountDefenderAssessment.Builder getAccountDefenderAssessmentBuilder()

Assessment returned by Account Defender when a hashed_account_id is provided.

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

Returns
TypeDescription
AccountDefenderAssessment.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEvent()

public Event getEvent()

The event being assessed.

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

Returns
TypeDescription
Event

The event.

getEventBuilder()

public Event.Builder getEventBuilder()

The event being assessed.

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

Returns
TypeDescription
Event.Builder

getEventOrBuilder()

public EventOrBuilder getEventOrBuilder()

The event being assessed.

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

Returns
TypeDescription
EventOrBuilder

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.

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.

getPasswordLeakVerificationBuilder()

public PasswordLeakVerification.Builder getPasswordLeakVerificationBuilder()

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

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.

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.

getTokenPropertiesBuilder()

public TokenProperties.Builder getTokenPropertiesBuilder()

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

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAccountDefenderAssessment(AccountDefenderAssessment value)

public Assessment.Builder mergeAccountDefenderAssessment(AccountDefenderAssessment value)

Assessment returned by Account Defender when a hashed_account_id is provided.

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

Parameter
NameDescription
valueAccountDefenderAssessment
Returns
TypeDescription
Assessment.Builder

mergeEvent(Event value)

public Assessment.Builder mergeEvent(Event value)

The event being assessed.

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

Parameter
NameDescription
valueEvent
Returns
TypeDescription
Assessment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Assessment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Assessment.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Assessment.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Assessment.Builder
Overrides

mergeFrom(Assessment other)

public Assessment.Builder mergeFrom(Assessment other)
Parameter
NameDescription
otherAssessment
Returns
TypeDescription
Assessment.Builder

mergePasswordLeakVerification(PasswordLeakVerification value)

public Assessment.Builder mergePasswordLeakVerification(PasswordLeakVerification value)

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;

Parameter
NameDescription
valuePasswordLeakVerification
Returns
TypeDescription
Assessment.Builder

mergeTokenProperties(TokenProperties value)

public Assessment.Builder mergeTokenProperties(TokenProperties value)

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTokenProperties
Returns
TypeDescription
Assessment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Assessment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Assessment.Builder
Overrides

setAccountDefenderAssessment(AccountDefenderAssessment value)

public Assessment.Builder setAccountDefenderAssessment(AccountDefenderAssessment value)

Assessment returned by Account Defender when a hashed_account_id is provided.

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

Parameter
NameDescription
valueAccountDefenderAssessment
Returns
TypeDescription
Assessment.Builder

setAccountDefenderAssessment(AccountDefenderAssessment.Builder builderForValue)

public Assessment.Builder setAccountDefenderAssessment(AccountDefenderAssessment.Builder builderForValue)

Assessment returned by Account Defender when a hashed_account_id is provided.

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

Parameter
NameDescription
builderForValueAccountDefenderAssessment.Builder
Returns
TypeDescription
Assessment.Builder

setEvent(Event value)

public Assessment.Builder setEvent(Event value)

The event being assessed.

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

Parameter
NameDescription
valueEvent
Returns
TypeDescription
Assessment.Builder

setEvent(Event.Builder builderForValue)

public Assessment.Builder setEvent(Event.Builder builderForValue)

The event being assessed.

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

Parameter
NameDescription
builderForValueEvent.Builder
Returns
TypeDescription
Assessment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Assessment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Assessment.Builder
Overrides

setName(String value)

public Assessment.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Assessment.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

setPasswordLeakVerification(PasswordLeakVerification value)

public Assessment.Builder setPasswordLeakVerification(PasswordLeakVerification value)

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;

Parameter
NameDescription
valuePasswordLeakVerification
Returns
TypeDescription
Assessment.Builder

setPasswordLeakVerification(PasswordLeakVerification.Builder builderForValue)

public Assessment.Builder setPasswordLeakVerification(PasswordLeakVerification.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuePasswordLeakVerification.Builder
Returns
TypeDescription
Assessment.Builder

setReasons(int index, Assessment.ClassificationReason value)

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

Output only. Reasons contributing to the risk analysis verdict.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueAssessment.ClassificationReason

The reasons to set.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

setReasonsValue(int index, int value)

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

Output only. Reasons contributing to the risk analysis verdict.

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

Parameters
NameDescription
indexint

The index to set the value at.

valueint

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

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Assessment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Assessment.Builder
Overrides

setScore(float value)

public Assessment.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 = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuefloat

The score to set.

Returns
TypeDescription
Assessment.Builder

This builder for chaining.

setTokenProperties(TokenProperties value)

public Assessment.Builder setTokenProperties(TokenProperties value)

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTokenProperties
Returns
TypeDescription
Assessment.Builder

setTokenProperties(TokenProperties.Builder builderForValue)

public Assessment.Builder setTokenProperties(TokenProperties.Builder builderForValue)

Output only. Properties of the provided event token.

.google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueTokenProperties.Builder
Returns
TypeDescription
Assessment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Assessment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Assessment.Builder
Overrides