public final class AnnotateAssessmentRequest extends GeneratedMessageV3 implements AnnotateAssessmentRequestOrBuilder
The request message to annotate an Assessment.
Protobuf type google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest
Fields
ANNOTATION_FIELD_NUMBER
public static final int ANNOTATION_FIELD_NUMBER
Field Value
HASHED_ACCOUNT_ID_FIELD_NUMBER
public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
REASONS_FIELD_NUMBER
public static final int REASONS_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
Returns
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.
|
getDefaultInstance()
public static AnnotateAssessmentRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public AnnotateAssessmentRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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
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
getParserForType()
public Parser<AnnotateAssessmentRequest> getParserForType()
Returns
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.
|
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static AnnotateAssessmentRequest.Builder newBuilder()
Returns
newBuilder(AnnotateAssessmentRequest prototype)
public static AnnotateAssessmentRequest.Builder newBuilder(AnnotateAssessmentRequest prototype)
Parameter
Returns
newBuilderForType()
public AnnotateAssessmentRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnnotateAssessmentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AnnotateAssessmentRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AnnotateAssessmentRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AnnotateAssessmentRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AnnotateAssessmentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AnnotateAssessmentRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AnnotateAssessmentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AnnotateAssessmentRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnnotateAssessmentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AnnotateAssessmentRequest> parser()
Returns
toBuilder()
public AnnotateAssessmentRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions