com.google.recaptchaenterprise.v1beta1

Class AnnotateAssessmentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AnnotateAssessmentRequestOrBuilder, Serializable

public final class AnnotateAssessmentRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnnotateAssessmentRequestOrBuilder

 The request message to annotate an Assessment.
 

Protobuf type google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotateAssessmentRequest.Annotation Enum that represents the types of annotations.
static class	AnnotateAssessmentRequest.Builder The request message to annotate an Assessment.
static class	AnnotateAssessmentRequest.Reason Enum that represents potential reasons for annotating an assessment.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANNOTATION_FIELD_NUMBER
static int	HASHED_ACCOUNT_ID_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	REASONS_FIELD_NUMBER
static int	TRANSACTION_EVENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AnnotateAssessmentRequest.Annotation	getAnnotation() Optional.
int	getAnnotationValue() Optional.
static AnnotateAssessmentRequest	getDefaultInstance()
AnnotateAssessmentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.ByteString	getHashedAccountId() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<AnnotateAssessmentRequest>	getParserForType()
AnnotateAssessmentRequest.Reason	getReasons(int index) Optional.
int	getReasonsCount() Optional.
List<AnnotateAssessmentRequest.Reason>	getReasonsList() Optional.
int	getReasonsValue(int index) Optional.
List<Integer>	getReasonsValueList() Optional.
int	getSerializedSize()
TransactionEvent	getTransactionEvent() Optional.
TransactionEventOrBuilder	getTransactionEventOrBuilder() Optional.
int	hashCode()
boolean	hasTransactionEvent() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnnotateAssessmentRequest.Builder	newBuilder()
static AnnotateAssessmentRequest.Builder	newBuilder(AnnotateAssessmentRequest prototype)
AnnotateAssessmentRequest.Builder	newBuilderForType()
protected AnnotateAssessmentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnnotateAssessmentRequest	parseDelimitedFrom(InputStream input)
static AnnotateAssessmentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateAssessmentRequest	parseFrom(byte[] data)
static AnnotateAssessmentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateAssessmentRequest	parseFrom(ByteBuffer data)
static AnnotateAssessmentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateAssessmentRequest	parseFrom(com.google.protobuf.ByteString data)
static AnnotateAssessmentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateAssessmentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AnnotateAssessmentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateAssessmentRequest	parseFrom(InputStream input)
static AnnotateAssessmentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnnotateAssessmentRequest>	parser()
AnnotateAssessmentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATION_FIELD_NUMBER

public static final int ANNOTATION_FIELD_NUMBER

See Also:

Constant Field Values

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER

See Also:

Constant Field Values

HASHED_ACCOUNT_ID_FIELD_NUMBER

public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_EVENT_FIELD_NUMBER

public static final int TRANSACTION_EVENT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getName in interface AnnotateAssessmentRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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) = { ... }

Specified by:

getNameBytes in interface AnnotateAssessmentRequestOrBuilder

Returns:

The bytes for name.

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];

Specified by:

getAnnotationValue in interface AnnotateAssessmentRequestOrBuilder

Returns:

The enum numeric value on the wire for annotation.

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];

Specified by:

getAnnotation in interface AnnotateAssessmentRequestOrBuilder

Returns:

The annotation.

getReasonsList

public List<AnnotateAssessmentRequest.Reason> getReasonsList()

 Optional. Reasons for the annotation that are assigned to the event.
 

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

Specified by:

getReasonsList in interface AnnotateAssessmentRequestOrBuilder

Returns:

A list containing the reasons.

getReasonsCount

public int getReasonsCount()

 Optional. Reasons for the annotation that are assigned to the event.
 

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

Specified by:

getReasonsCount in interface AnnotateAssessmentRequestOrBuilder

Returns:

The count of reasons.

getReasons

public AnnotateAssessmentRequest.Reason getReasons(int index)

 Optional. Reasons for the annotation that are assigned to the event.
 

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

Specified by:

getReasons in interface AnnotateAssessmentRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The 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.v1beta1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getReasonsValueList in interface AnnotateAssessmentRequestOrBuilder

Returns:

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

getReasonsValue

public int getReasonsValue(int index)

 Optional. Reasons for the annotation that are assigned to the event.
 

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

Specified by:

getReasonsValue in interface AnnotateAssessmentRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

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

getHashedAccountId

public com.google.protobuf.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];

Specified by:

getHashedAccountId in interface AnnotateAssessmentRequestOrBuilder

Returns:

The hashedAccountId.

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];

Specified by:

hasTransactionEvent in interface AnnotateAssessmentRequestOrBuilder

Returns:

Whether the transactionEvent field is set.

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];

Specified by:

getTransactionEvent in interface AnnotateAssessmentRequestOrBuilder

Returns:

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];

Specified by:

getTransactionEventOrBuilder in interface AnnotateAssessmentRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateAssessmentRequest parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static AnnotateAssessmentRequest parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateAssessmentRequest parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static AnnotateAssessmentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static AnnotateAssessmentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public AnnotateAssessmentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnnotateAssessmentRequest.Builder newBuilder()

newBuilder

public static AnnotateAssessmentRequest.Builder newBuilder(AnnotateAssessmentRequest prototype)

toBuilder

public AnnotateAssessmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnnotateAssessmentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnnotateAssessmentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnnotateAssessmentRequest> parser()

getParserForType

public com.google.protobuf.Parser<AnnotateAssessmentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnnotateAssessmentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder