Class AnnotateAssessmentRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.AnnotateAssessmentRequest
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,AnnotateAssessmentRequestOrBuilder,Serializable
@Generated
public final class AnnotateAssessmentRequest
extends com.google.protobuf.GeneratedMessage
implements AnnotateAssessmentRequestOrBuilder
The request message to annotate an Assessment.Protobuf type
google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumEnum that represents the types of annotations.static final classThe request message to annotate an Assessment.static enumEnum that represents potential reasons for annotating an assessment.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanOptional.com.google.protobuf.ByteStringOptional.Optional.intOptional.static AnnotateAssessmentRequeststatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.ByteStringOptional.getName()Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.Parser<AnnotateAssessmentRequest>Optional.Optional.getReasons(int index) Optional.intOptional.Optional.intgetReasonsValue(int index) Optional.Optional.intOptional.Optional.inthashCode()booleanOptional.booleanOptional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(AnnotateAssessmentRequest prototype) protected AnnotateAssessmentRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static AnnotateAssessmentRequestparseDelimitedFrom(InputStream input) static AnnotateAssessmentRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AnnotateAssessmentRequestparseFrom(byte[] data) static AnnotateAssessmentRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AnnotateAssessmentRequestparseFrom(com.google.protobuf.ByteString data) static AnnotateAssessmentRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AnnotateAssessmentRequestparseFrom(com.google.protobuf.CodedInputStream input) static AnnotateAssessmentRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AnnotateAssessmentRequestparseFrom(InputStream input) static AnnotateAssessmentRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AnnotateAssessmentRequestparseFrom(ByteBuffer data) static AnnotateAssessmentRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<AnnotateAssessmentRequest>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
ANNOTATION_FIELD_NUMBER
public static final int ANNOTATION_FIELD_NUMBER- See Also:
-
REASONS_FIELD_NUMBER
public static final int REASONS_FIELD_NUMBER- See Also:
-
ACCOUNT_ID_FIELD_NUMBER
public static final int ACCOUNT_ID_FIELD_NUMBER- See Also:
-
HASHED_ACCOUNT_ID_FIELD_NUMBER
public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER- See Also:
-
TRANSACTION_EVENT_FIELD_NUMBER
public static final int TRANSACTION_EVENT_FIELD_NUMBER- See Also:
-
PHONE_AUTHENTICATION_EVENT_FIELD_NUMBER
public static final int PHONE_AUTHENTICATION_EVENT_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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) = { ... }- Specified by:
getNamein interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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) = { ... }- Specified by:
getNameBytesin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The bytes for name.
-
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];- Specified by:
getAnnotationValuein interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The enum numeric value on the wire for 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];- Specified by:
getAnnotationin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The annotation.
-
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];- Specified by:
getReasonsListin interfaceAnnotateAssessmentRequestOrBuilder- 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.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReasonsCountin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The count of reasons.
-
getReasons
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];- Specified by:
getReasonsin interfaceAnnotateAssessmentRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The reasons at the given index.
-
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];- Specified by:
getReasonsValueListin interfaceAnnotateAssessmentRequestOrBuilder- 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.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getReasonsValuein interfaceAnnotateAssessmentRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of reasons at the given index.
-
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];- Specified by:
getAccountIdin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The accountId.
-
getAccountIdBytes
public com.google.protobuf.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];- Specified by:
getAccountIdBytesin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The bytes for accountId.
-
getHashedAccountId
public com.google.protobuf.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];- Specified by:
getHashedAccountIdin interfaceAnnotateAssessmentRequestOrBuilder- 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.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasTransactionEventin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- Whether the transactionEvent field is set.
-
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];- Specified by:
getTransactionEventin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The transactionEvent.
-
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];- Specified by:
getTransactionEventOrBuilderin interfaceAnnotateAssessmentRequestOrBuilder
-
hasPhoneAuthenticationEvent
public boolean hasPhoneAuthenticationEvent()Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.
.google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasPhoneAuthenticationEventin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- Whether the phoneAuthenticationEvent field is set.
-
getPhoneAuthenticationEvent
Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.
.google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPhoneAuthenticationEventin interfaceAnnotateAssessmentRequestOrBuilder- Returns:
- The phoneAuthenticationEvent.
-
getPhoneAuthenticationEventOrBuilder
Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.
.google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getPhoneAuthenticationEventOrBuilderin interfaceAnnotateAssessmentRequestOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static AnnotateAssessmentRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AnnotateAssessmentRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-