public final class AnnotateAssessmentRequest extends GeneratedMessageV3 implements AnnotateAssessmentRequestOrBuilder
The request message to annotate an Assessment.
Protobuf type google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AnnotateAssessmentRequest.Builder newBuilder()
newBuilder(AnnotateAssessmentRequest prototype)
public static AnnotateAssessmentRequest.Builder newBuilder(AnnotateAssessmentRequest prototype)
public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input)
public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AnnotateAssessmentRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AnnotateAssessmentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(CodedInputStream input)
public static AnnotateAssessmentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(InputStream input)
public static AnnotateAssessmentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AnnotateAssessmentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AnnotateAssessmentRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];
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.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()
getHashedAccountId()
public ByteString getHashedAccountId()
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 |
|---|
| Type | Description |
ByteString | The hashedAccountId.
|
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()
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.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
getReasonsCount()
public 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 |
|---|
| Type | Description |
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.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. 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];
| 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. 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 |
|---|
| 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];
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];
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AnnotateAssessmentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotateAssessmentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AnnotateAssessmentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
