Class Assessment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1beta1.Assessment
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, AssessmentOrBuilder, Serializable

@Generated public final class Assessment extends com.google.protobuf.GeneratedMessage implements AssessmentOrBuilder
 A reCAPTCHA Enterprise assessment resource.
 
Protobuf type google.cloud.recaptchaenterprise.v1beta1.Assessment
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • EVENT_FIELD_NUMBER

      public static final int EVENT_FIELD_NUMBER
      See Also:
    • SCORE_FIELD_NUMBER

      public static final int SCORE_FIELD_NUMBER
      See Also:
    • TOKEN_PROPERTIES_FIELD_NUMBER

      public static final int TOKEN_PROPERTIES_FIELD_NUMBER
      See Also:
    • REASONS_FIELD_NUMBER

      public static final int REASONS_FIELD_NUMBER
      See Also:
    • PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER

      public static final int PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER
      See Also:
    • ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER

      public static final int ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER
      See Also:
    • FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER

      public static final int FRAUD_PREVENTION_ASSESSMENT_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()
       Output only. The resource name for the Assessment in the format
       `projects/{project_number}/assessments/{assessment_id}`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface AssessmentOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name for the Assessment in the format
       `projects/{project_number}/assessments/{assessment_id}`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface AssessmentOrBuilder
      Returns:
      The bytes for name.
    • hasEvent

      public boolean hasEvent()
       The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
      Specified by:
      hasEvent in interface AssessmentOrBuilder
      Returns:
      Whether the event field is set.
    • getEvent

      public Event getEvent()
       The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
      Specified by:
      getEvent in interface AssessmentOrBuilder
      Returns:
      The event.
    • getEventOrBuilder

      public EventOrBuilder getEventOrBuilder()
       The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
      Specified by:
      getEventOrBuilder in interface AssessmentOrBuilder
    • getScore

      public float getScore()
       Output only. Legitimate event score from 0.0 to 1.0.
       (1.0 means very likely legitimate traffic while 0.0 means very likely
       non-legitimate traffic).
       
      float score = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getScore in interface AssessmentOrBuilder
      Returns:
      The score.
    • hasTokenProperties

      public boolean hasTokenProperties()
       Output only. Properties of the provided event token.
       
      .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasTokenProperties in interface AssessmentOrBuilder
      Returns:
      Whether the tokenProperties field is set.
    • getTokenProperties

      public TokenProperties getTokenProperties()
       Output only. Properties of the provided event token.
       
      .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTokenProperties in interface AssessmentOrBuilder
      Returns:
      The tokenProperties.
    • getTokenPropertiesOrBuilder

      public TokenPropertiesOrBuilder getTokenPropertiesOrBuilder()
       Output only. Properties of the provided event token.
       
      .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTokenPropertiesOrBuilder in interface AssessmentOrBuilder
    • getReasonsList

      public List<Assessment.ClassificationReason> getReasonsList()
       Output only. Reasons contributing to the risk analysis verdict.
       
      repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReasonsList in interface AssessmentOrBuilder
      Returns:
      A list containing the reasons.
    • getReasonsCount

      public int getReasonsCount()
       Output only. Reasons contributing to the risk analysis verdict.
       
      repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReasonsCount in interface AssessmentOrBuilder
      Returns:
      The count of reasons.
    • getReasons

      public Assessment.ClassificationReason getReasons(int index)
       Output only. Reasons contributing to the risk analysis verdict.
       
      repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReasons in interface AssessmentOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The reasons at the given index.
    • getReasonsValueList

      public List<Integer> getReasonsValueList()
       Output only. Reasons contributing to the risk analysis verdict.
       
      repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReasonsValueList in interface AssessmentOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for reasons.
    • getReasonsValue

      public int getReasonsValue(int index)
       Output only. Reasons contributing to the risk analysis verdict.
       
      repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReasonsValue in interface AssessmentOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of reasons at the given index.
    • hasPasswordLeakVerification

      public boolean hasPasswordLeakVerification()
       Information about the user's credentials used to check for leaks.
       This feature is part of the Early Access Program (EAP). Exercise caution,
       and do not deploy integrations based on this feature in a production
       environment.
       
      .google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;
      Specified by:
      hasPasswordLeakVerification in interface AssessmentOrBuilder
      Returns:
      Whether the passwordLeakVerification field is set.
    • getPasswordLeakVerification

      public PasswordLeakVerification getPasswordLeakVerification()
       Information about the user's credentials used to check for leaks.
       This feature is part of the Early Access Program (EAP). Exercise caution,
       and do not deploy integrations based on this feature in a production
       environment.
       
      .google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;
      Specified by:
      getPasswordLeakVerification in interface AssessmentOrBuilder
      Returns:
      The passwordLeakVerification.
    • getPasswordLeakVerificationOrBuilder

      public PasswordLeakVerificationOrBuilder getPasswordLeakVerificationOrBuilder()
       Information about the user's credentials used to check for leaks.
       This feature is part of the Early Access Program (EAP). Exercise caution,
       and do not deploy integrations based on this feature in a production
       environment.
       
      .google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification password_leak_verification = 7;
      Specified by:
      getPasswordLeakVerificationOrBuilder in interface AssessmentOrBuilder
    • hasAccountDefenderAssessment

      public boolean hasAccountDefenderAssessment()
       Assessment returned by account defender when a hashed_account_id is
       provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
      Specified by:
      hasAccountDefenderAssessment in interface AssessmentOrBuilder
      Returns:
      Whether the accountDefenderAssessment field is set.
    • getAccountDefenderAssessment

      public AccountDefenderAssessment getAccountDefenderAssessment()
       Assessment returned by account defender when a hashed_account_id is
       provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
      Specified by:
      getAccountDefenderAssessment in interface AssessmentOrBuilder
      Returns:
      The accountDefenderAssessment.
    • getAccountDefenderAssessmentOrBuilder

      public AccountDefenderAssessmentOrBuilder getAccountDefenderAssessmentOrBuilder()
       Assessment returned by account defender when a hashed_account_id is
       provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
      Specified by:
      getAccountDefenderAssessmentOrBuilder in interface AssessmentOrBuilder
    • hasFraudPreventionAssessment

      public boolean hasFraudPreventionAssessment()
       Assessment returned by Fraud Prevention when TransactionData is provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
      Specified by:
      hasFraudPreventionAssessment in interface AssessmentOrBuilder
      Returns:
      Whether the fraudPreventionAssessment field is set.
    • getFraudPreventionAssessment

      public FraudPreventionAssessment getFraudPreventionAssessment()
       Assessment returned by Fraud Prevention when TransactionData is provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
      Specified by:
      getFraudPreventionAssessment in interface AssessmentOrBuilder
      Returns:
      The fraudPreventionAssessment.
    • getFraudPreventionAssessmentOrBuilder

      public FraudPreventionAssessmentOrBuilder getFraudPreventionAssessmentOrBuilder()
       Assessment returned by Fraud Prevention when TransactionData is provided.
       
      .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
      Specified by:
      getFraudPreventionAssessmentOrBuilder in interface AssessmentOrBuilder
    • 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 Assessment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static Assessment parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Assessment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Assessment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Assessment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Assessment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Assessment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public Assessment.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static Assessment.Builder newBuilder()
    • newBuilder

      public static Assessment.Builder newBuilder(Assessment prototype)
    • toBuilder

      public Assessment.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected Assessment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static Assessment getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<Assessment> parser()
    • getParserForType

      public com.google.protobuf.Parser<Assessment> 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 Assessment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder