Interface AnnotateAssessmentRequestOrBuilder (3.51.0) 

public interface AnnotateAssessmentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountId()

public abstract String getAccountId()

Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

string account_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The accountId.

getAccountIdBytes()

public abstract ByteString getAccountIdBytes()

Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

string account_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for accountId.

getAnnotation()

public abstract AnnotateAssessmentRequest.Annotation getAnnotation()

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

.google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AnnotateAssessmentRequest.Annotation

The annotation.

getAnnotationValue()

public abstract int getAnnotationValue()

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

.google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for annotation.

getHashedAccountId()

public abstract ByteString getHashedAccountId()

Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

bytes hashed_account_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The hashedAccountId.

getName()

public abstract String getName()

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getReasons(int index)

public abstract AnnotateAssessmentRequest.Reason getReasons(int index)

Optional. Reasons for the annotation that are assigned to the event.

repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
AnnotateAssessmentRequest.Reason

The reasons at the given index.

getReasonsCount()

public abstract int getReasonsCount()

Optional. Reasons for the annotation that are assigned to the event.

repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of reasons.

getReasonsList()

public abstract List<AnnotateAssessmentRequest.Reason> getReasonsList()

Optional. Reasons for the annotation that are assigned to the event.

repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Reason>

A list containing the reasons.

getReasonsValue(int index)

public abstract int getReasonsValue(int index)

Optional. Reasons for the annotation that are assigned to the event.

repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

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 abstract List<Integer> getReasonsValueList()

Optional. Reasons for the annotation that are assigned to the event.

repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Integer>

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

getTransactionEvent()

public abstract TransactionEvent getTransactionEvent()

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

.google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionEvent

The transactionEvent.

getTransactionEventOrBuilder()

public abstract TransactionEventOrBuilder getTransactionEventOrBuilder()

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

.google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionEventOrBuilder

hasTransactionEvent()

public abstract boolean hasTransactionEvent()

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

.google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the transactionEvent field is set.