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:
  • 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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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) = { ... }
      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}/assessments/{assessment}`.
       
      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 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:
      getAnnotationValue in interface AnnotateAssessmentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for annotation.
    • 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];
      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.v1.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.v1.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.v1.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.v1.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.v1.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.
    • 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];
      Specified by:
      getAccountId in interface AnnotateAssessmentRequestOrBuilder
      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:
      getAccountIdBytes in interface AnnotateAssessmentRequestOrBuilder
      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:
      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.v1.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.v1.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.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransactionEventOrBuilder in interface AnnotateAssessmentRequestOrBuilder
    • 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:
      hasPhoneAuthenticationEvent in interface AnnotateAssessmentRequestOrBuilder
      Returns:
      Whether the phoneAuthenticationEvent field is set.
    • getPhoneAuthenticationEvent

      public PhoneAuthenticationEvent 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:
      getPhoneAuthenticationEvent in interface AnnotateAssessmentRequestOrBuilder
      Returns:
      The phoneAuthenticationEvent.
    • getPhoneAuthenticationEventOrBuilder

      public PhoneAuthenticationEventOrBuilder 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:
      getPhoneAuthenticationEventOrBuilder in interface AnnotateAssessmentRequestOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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

      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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

      public AnnotateAssessmentRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder