com.google.recaptchaenterprise.v1

Interface AnnotateAssessmentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AnnotateAssessmentRequest, AnnotateAssessmentRequest.Builder

public interface AnnotateAssessmentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AnnotateAssessmentRequest.Annotation	getAnnotation() Optional.
int	getAnnotationValue() Optional.
com.google.protobuf.ByteString	getHashedAccountId() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
AnnotateAssessmentRequest.Reason	getReasons(int index) Optional.
int	getReasonsCount() Optional.
List<AnnotateAssessmentRequest.Reason>	getReasonsList() Optional.
int	getReasonsValue(int index) Optional.
List<Integer>	getReasonsValueList() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getAnnotationValue

int getAnnotationValue()

 Optional. The annotation that will be 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:

The enum numeric value on the wire for annotation.

getAnnotation

AnnotateAssessmentRequest.Annotation getAnnotation()

 Optional. The annotation that will be 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:

The annotation.

getReasonsList

List<AnnotateAssessmentRequest.Reason> getReasonsList()

 Optional. Optional reasons for the annotation that will be assigned to the Event.
 

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

Returns:

A list containing the reasons.

getReasonsCount

int getReasonsCount()

 Optional. Optional reasons for the annotation that will be assigned to the Event.
 

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

Returns:

The count of reasons.

getReasons

AnnotateAssessmentRequest.Reason getReasons(int index)

 Optional. Optional reasons for the annotation that will be assigned to the Event.
 

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

Parameters:

index - The index of the element to return.

Returns:

The reasons at the given index.

getReasonsValueList

List<Integer> getReasonsValueList()

 Optional. Optional reasons for the annotation that will be assigned to the Event.
 

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

Returns:

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

getReasonsValue

int getReasonsValue(int index)

 Optional. Optional reasons for the annotation that will be assigned to the Event.
 

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

Parameters:

index - The index of the value to return.

Returns:

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

getHashedAccountId

com.google.protobuf.ByteString getHashedAccountId()

 Optional. Optional unique stable hashed user identifier to apply to the assessment.
 This is an alternative to setting the hashed_account_id in
 CreateAssessment, for example when the account identifier is not yet known
 in the initial request. It is recommended that the identifier is hashed
 using hmac-sha256 with stable secret.
 

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

Returns:

The hashedAccountId.