Class AnnotateAssessmentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AnnotateAssessmentRequest.Builder>
com.google.recaptchaenterprise.v1.AnnotateAssessmentRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AnnotateAssessmentRequestOrBuilder, Cloneable
Enclosing class:
AnnotateAssessmentRequest

public static final class AnnotateAssessmentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<AnnotateAssessmentRequest.Builder> implements AnnotateAssessmentRequestOrBuilder
 The request message to annotate an Assessment.
 
Protobuf type google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest
  • 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.Builder<AnnotateAssessmentRequest.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AnnotateAssessmentRequest.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AnnotateAssessmentRequest.Builder>
    • getDefaultInstanceForType

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

      public AnnotateAssessmentRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public AnnotateAssessmentRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public AnnotateAssessmentRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnnotateAssessmentRequest.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AnnotateAssessmentRequest.Builder>
    • mergeFrom

      public AnnotateAssessmentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnnotateAssessmentRequest.Builder>
      Throws:
      IOException
    • 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.
    • setName

      public AnnotateAssessmentRequest.Builder setName(String value)
       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) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

       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:
      This builder for chaining.
    • setNameBytes

      public AnnotateAssessmentRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • 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.
    • setAnnotationValue

      public AnnotateAssessmentRequest.Builder setAnnotationValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for annotation to set.
      Returns:
      This builder for chaining.
    • 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.
    • setAnnotation

       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];
      Parameters:
      value - The annotation to set.
      Returns:
      This builder for chaining.
    • clearAnnotation

      public AnnotateAssessmentRequest.Builder clearAnnotation()
       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];
      Returns:
      This builder for chaining.
    • 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.
    • setReasons

       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];
      Parameters:
      index - The index to set the value at.
      value - The reasons to set.
      Returns:
      This builder for chaining.
    • addReasons

       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];
      Parameters:
      value - The reasons to add.
      Returns:
      This builder for chaining.
    • addAllReasons

       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];
      Parameters:
      values - The reasons to add.
      Returns:
      This builder for chaining.
    • clearReasons

      public AnnotateAssessmentRequest.Builder clearReasons()
       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];
      Returns:
      This builder for chaining.
    • 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.
    • setReasonsValue

      public AnnotateAssessmentRequest.Builder setReasonsValue(int index, int value)
       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];
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for reasons to set.
      Returns:
      This builder for chaining.
    • addReasonsValue

      public AnnotateAssessmentRequest.Builder addReasonsValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for reasons to add.
      Returns:
      This builder for chaining.
    • addAllReasonsValue

      public AnnotateAssessmentRequest.Builder addAllReasonsValue(Iterable<Integer> values)
       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];
      Parameters:
      values - The enum numeric values on the wire for reasons to add.
      Returns:
      This builder for chaining.
    • 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.
    • setAccountId

      public AnnotateAssessmentRequest.Builder setAccountId(String value)
       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];
      Parameters:
      value - The accountId to set.
      Returns:
      This builder for chaining.
    • clearAccountId

      public AnnotateAssessmentRequest.Builder clearAccountId()
       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];
      Returns:
      This builder for chaining.
    • setAccountIdBytes

      public AnnotateAssessmentRequest.Builder setAccountIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for accountId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setHashedAccountId

      public AnnotateAssessmentRequest.Builder setHashedAccountId(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The hashedAccountId to set.
      Returns:
      This builder for chaining.
    • clearHashedAccountId

      public AnnotateAssessmentRequest.Builder clearHashedAccountId()
       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];
      Returns:
      This builder for chaining.
    • 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.
    • setTransactionEvent

      public AnnotateAssessmentRequest.Builder setTransactionEvent(TransactionEvent value)
       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];
    • setTransactionEvent

      public AnnotateAssessmentRequest.Builder setTransactionEvent(TransactionEvent.Builder builderForValue)
       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];
    • mergeTransactionEvent

      public AnnotateAssessmentRequest.Builder mergeTransactionEvent(TransactionEvent value)
       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];
    • clearTransactionEvent

      public AnnotateAssessmentRequest.Builder clearTransactionEvent()
       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];
    • getTransactionEventBuilder

      public TransactionEvent.Builder getTransactionEventBuilder()
       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];
    • 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.
    • setPhoneAuthenticationEvent

      public AnnotateAssessmentRequest.Builder setPhoneAuthenticationEvent(PhoneAuthenticationEvent value)
       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];
    • setPhoneAuthenticationEvent

      public AnnotateAssessmentRequest.Builder setPhoneAuthenticationEvent(PhoneAuthenticationEvent.Builder builderForValue)
       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];
    • mergePhoneAuthenticationEvent

      public AnnotateAssessmentRequest.Builder mergePhoneAuthenticationEvent(PhoneAuthenticationEvent value)
       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];
    • clearPhoneAuthenticationEvent

      public AnnotateAssessmentRequest.Builder clearPhoneAuthenticationEvent()
       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];
    • getPhoneAuthenticationEventBuilder

      public PhoneAuthenticationEvent.Builder getPhoneAuthenticationEventBuilder()
       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];
    • 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