Class AnnotateAssessmentRequest (3.13.0)

public final class AnnotateAssessmentRequest extends GeneratedMessageV3 implements AnnotateAssessmentRequestOrBuilder

The request message to annotate an Assessment.

Protobuf type google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

Static Fields

ANNOTATION_FIELD_NUMBER

public static final int ANNOTATION_FIELD_NUMBER
Field Value
TypeDescription
int

HASHED_ACCOUNT_ID_FIELD_NUMBER

public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_EVENT_FIELD_NUMBER

public static final int TRANSACTION_EVENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateAssessmentRequest getDefaultInstance()
Returns
TypeDescription
AnnotateAssessmentRequest

getDescriptor()

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

newBuilder()

public static AnnotateAssessmentRequest.Builder newBuilder()
Returns
TypeDescription
AnnotateAssessmentRequest.Builder

newBuilder(AnnotateAssessmentRequest prototype)

public static AnnotateAssessmentRequest.Builder newBuilder(AnnotateAssessmentRequest prototype)
Parameter
NameDescription
prototypeAnnotateAssessmentRequest
Returns
TypeDescription
AnnotateAssessmentRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AnnotateAssessmentRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateAssessmentRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateAssessmentRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AnnotateAssessmentRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AnnotateAssessmentRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AnnotateAssessmentRequest> parser()
Returns
TypeDescription
Parser<AnnotateAssessmentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotation()

public 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.v1beta1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
AnnotateAssessmentRequest.Annotation

The annotation.

getAnnotationValue()

public 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.v1beta1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for annotation.

getDefaultInstanceForType()

public AnnotateAssessmentRequest getDefaultInstanceForType()
Returns
TypeDescription
AnnotateAssessmentRequest

getHashedAccountId()

public 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
TypeDescription
ByteString

The hashedAccountId.

getName()

public String getName()

Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<AnnotateAssessmentRequest> getParserForType()
Returns
TypeDescription
Parser<AnnotateAssessmentRequest>
Overrides

getReasons(int index)

public AnnotateAssessmentRequest.Reason getReasons(int index)

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

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
AnnotateAssessmentRequest.Reason

The reasons at the given index.

getReasonsCount()

public int getReasonsCount()

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

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

Returns
TypeDescription
int

The count of reasons.

getReasonsList()

public List<AnnotateAssessmentRequest.Reason> getReasonsList()

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

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

Returns
TypeDescription
List<Reason>

A list containing the reasons.

getReasonsValue(int index)

public int getReasonsValue(int index)

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

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

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()

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

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

Returns
TypeDescription
List<Integer>

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTransactionEvent()

public 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.v1beta1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TransactionEvent

The transactionEvent.

getTransactionEventOrBuilder()

public 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.v1beta1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
TransactionEventOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasTransactionEvent()

public 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.v1beta1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the transactionEvent field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AnnotateAssessmentRequest.Builder newBuilderForType()
Returns
TypeDescription
AnnotateAssessmentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateAssessmentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AnnotateAssessmentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AnnotateAssessmentRequest.Builder toBuilder()
Returns
TypeDescription
AnnotateAssessmentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException