Package com.google.recaptchaenterprise.v1

Interface AnnotateAssessmentRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AnnotateAssessmentRequest, AnnotateAssessmentRequest.Builder
    public interface AnnotateAssessmentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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) = { ... }
        Returns:
        The name.

      • getNameBytes

        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) = { ... }
        Returns:
        The bytes for name.

      • getAnnotationValue

        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:
        The enum numeric value on the wire for annotation.

      • getAnnotation

        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:
        The annotation.

      • getReasonsList

        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:
        A list containing the reasons.

      • getReasonsCount

        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:
        The count of reasons.

      • getReasons

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The reasons at the given index.

      • getReasonsValueList

        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:
        A list containing the enum numeric values on the wire for reasons.

      • getReasonsValue

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of reasons at the given index.

      • getHashedAccountId

        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];
        Returns:
        The hashedAccountId.

      • hasTransactionEvent

        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:
        Whether the transactionEvent field is set.

      • getTransactionEvent

        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];
        Returns:
        The transactionEvent.

      • getTransactionEventOrBuilder

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