Class AnnotateAssessmentRequest (3.50.0)

public final class AnnotateAssessmentRequest extends GeneratedMessageV3 implements AnnotateAssessmentRequestOrBuilder

The request message to annotate an Assessment.

Protobuf type google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest

Static Fields

ACCOUNT_ID_FIELD_NUMBER

public static final int ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_FIELD_NUMBER

public static final int ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

HASHED_ACCOUNT_ID_FIELD_NUMBER

public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_EVENT_FIELD_NUMBER

public static final int TRANSACTION_EVENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotateAssessmentRequest getDefaultInstance()
Returns
Type Description
AnnotateAssessmentRequest

getDescriptor()

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

newBuilder()

public static AnnotateAssessmentRequest.Builder newBuilder()
Returns
Type Description
AnnotateAssessmentRequest.Builder

newBuilder(AnnotateAssessmentRequest prototype)

public static AnnotateAssessmentRequest.Builder newBuilder(AnnotateAssessmentRequest prototype)
Parameter
Name Description
prototype AnnotateAssessmentRequest
Returns
Type Description
AnnotateAssessmentRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnnotateAssessmentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnnotateAssessmentRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnnotateAssessmentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnnotateAssessmentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnnotateAssessmentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnnotateAssessmentRequest> parser()
Returns
Type Description
Parser<AnnotateAssessmentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccountId()

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

getDefaultInstanceForType()

public AnnotateAssessmentRequest getDefaultInstanceForType()
Returns
Type Description
AnnotateAssessmentRequest

getHashedAccountId()

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

getParserForType()

public Parser<AnnotateAssessmentRequest> getParserForType()
Returns
Type Description
Parser<AnnotateAssessmentRequest>
Overrides

getReasons(int index)

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
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.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TransactionEventOrBuilder

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

Returns
Type Description
boolean

Whether the transactionEvent field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnnotateAssessmentRequest.Builder newBuilderForType()
Returns
Type Description
AnnotateAssessmentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnnotateAssessmentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnnotateAssessmentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnnotateAssessmentRequest.Builder toBuilder()
Returns
Type Description
AnnotateAssessmentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException