Class Assessment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.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.v1.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:
    • RISK_ANALYSIS_FIELD_NUMBER

      public static final int RISK_ANALYSIS_FIELD_NUMBER
      See Also:
    • TOKEN_PROPERTIES_FIELD_NUMBER

      public static final int TOKEN_PROPERTIES_FIELD_NUMBER
      See Also:
    • ACCOUNT_VERIFICATION_FIELD_NUMBER

      public static final int ACCOUNT_VERIFICATION_FIELD_NUMBER
      See Also:
    • ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER

      public static final int ACCOUNT_DEFENDER_ASSESSMENT_FIELD_NUMBER
      See Also:
    • PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER

      public static final int PRIVATE_PASSWORD_LEAK_VERIFICATION_FIELD_NUMBER
      See Also:
    • FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER

      public static final int FIREWALL_POLICY_ASSESSMENT_FIELD_NUMBER
      See Also:
    • FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER

      public static final int FRAUD_PREVENTION_ASSESSMENT_FIELD_NUMBER
      See Also:
    • FRAUD_SIGNALS_FIELD_NUMBER

      public static final int FRAUD_SIGNALS_FIELD_NUMBER
      See Also:
    • PHONE_FRAUD_ASSESSMENT_FIELD_NUMBER

      public static final int PHONE_FRAUD_ASSESSMENT_FIELD_NUMBER
      See Also:
    • ASSESSMENT_ENVIRONMENT_FIELD_NUMBER

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

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

      public boolean hasEvent()
       Optional. The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEvent in interface AssessmentOrBuilder
      Returns:
      Whether the event field is set.
    • getEvent

      public Event getEvent()
       Optional. The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEvent in interface AssessmentOrBuilder
      Returns:
      The event.
    • getEventOrBuilder

      public EventOrBuilder getEventOrBuilder()
       Optional. The event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.Event event = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEventOrBuilder in interface AssessmentOrBuilder
    • hasRiskAnalysis

      public boolean hasRiskAnalysis()
       Output only. The risk analysis result for the event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRiskAnalysis in interface AssessmentOrBuilder
      Returns:
      Whether the riskAnalysis field is set.
    • getRiskAnalysis

      public RiskAnalysis getRiskAnalysis()
       Output only. The risk analysis result for the event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRiskAnalysis in interface AssessmentOrBuilder
      Returns:
      The riskAnalysis.
    • getRiskAnalysisOrBuilder

      public RiskAnalysisOrBuilder getRiskAnalysisOrBuilder()
       Output only. The risk analysis result for the event being assessed.
       
      .google.cloud.recaptchaenterprise.v1.RiskAnalysis risk_analysis = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRiskAnalysisOrBuilder in interface AssessmentOrBuilder
    • hasTokenProperties

      public boolean hasTokenProperties()
       Output only. Properties of the provided event token.
       
      .google.cloud.recaptchaenterprise.v1.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.v1.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.v1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTokenPropertiesOrBuilder in interface AssessmentOrBuilder
    • hasAccountVerification

      public boolean hasAccountVerification()
       Optional. Account verification information for identity verification. The
       assessment event must include a token and site key to use this feature.
       
      .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAccountVerification in interface AssessmentOrBuilder
      Returns:
      Whether the accountVerification field is set.
    • getAccountVerification

      public AccountVerificationInfo getAccountVerification()
       Optional. Account verification information for identity verification. The
       assessment event must include a token and site key to use this feature.
       
      .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccountVerification in interface AssessmentOrBuilder
      Returns:
      The accountVerification.
    • getAccountVerificationOrBuilder

      public AccountVerificationInfoOrBuilder getAccountVerificationOrBuilder()
       Optional. Account verification information for identity verification. The
       assessment event must include a token and site key to use this feature.
       
      .google.cloud.recaptchaenterprise.v1.AccountVerificationInfo account_verification = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAccountVerificationOrBuilder in interface AssessmentOrBuilder
    • hasAccountDefenderAssessment

      public boolean hasAccountDefenderAssessment()
       Output only. Assessment returned by account defender when an account
       identifier is provided.
       
      .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAccountDefenderAssessment in interface AssessmentOrBuilder
      Returns:
      Whether the accountDefenderAssessment field is set.
    • getAccountDefenderAssessment

      public AccountDefenderAssessment getAccountDefenderAssessment()
       Output only. Assessment returned by account defender when an account
       identifier is provided.
       
      .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountDefenderAssessment in interface AssessmentOrBuilder
      Returns:
      The accountDefenderAssessment.
    • getAccountDefenderAssessmentOrBuilder

      public AccountDefenderAssessmentOrBuilder getAccountDefenderAssessmentOrBuilder()
       Output only. Assessment returned by account defender when an account
       identifier is provided.
       
      .google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment account_defender_assessment = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAccountDefenderAssessmentOrBuilder in interface AssessmentOrBuilder
    • hasPrivatePasswordLeakVerification

      public boolean hasPrivatePasswordLeakVerification()
       Optional. The private password leak verification field contains the
       parameters that are used to to check for leaks privately without sharing
       user credentials.
       
      .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPrivatePasswordLeakVerification in interface AssessmentOrBuilder
      Returns:
      Whether the privatePasswordLeakVerification field is set.
    • getPrivatePasswordLeakVerification

      public PrivatePasswordLeakVerification getPrivatePasswordLeakVerification()
       Optional. The private password leak verification field contains the
       parameters that are used to to check for leaks privately without sharing
       user credentials.
       
      .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrivatePasswordLeakVerification in interface AssessmentOrBuilder
      Returns:
      The privatePasswordLeakVerification.
    • getPrivatePasswordLeakVerificationOrBuilder

      public PrivatePasswordLeakVerificationOrBuilder getPrivatePasswordLeakVerificationOrBuilder()
       Optional. The private password leak verification field contains the
       parameters that are used to to check for leaks privately without sharing
       user credentials.
       
      .google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification private_password_leak_verification = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrivatePasswordLeakVerificationOrBuilder in interface AssessmentOrBuilder
    • hasFirewallPolicyAssessment

      public boolean hasFirewallPolicyAssessment()
       Output only. Assessment returned when firewall policies belonging to the
       project are evaluated using the field firewall_policy_evaluation.
       
      .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFirewallPolicyAssessment in interface AssessmentOrBuilder
      Returns:
      Whether the firewallPolicyAssessment field is set.
    • getFirewallPolicyAssessment

      public FirewallPolicyAssessment getFirewallPolicyAssessment()
       Output only. Assessment returned when firewall policies belonging to the
       project are evaluated using the field firewall_policy_evaluation.
       
      .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFirewallPolicyAssessment in interface AssessmentOrBuilder
      Returns:
      The firewallPolicyAssessment.
    • getFirewallPolicyAssessmentOrBuilder

      public FirewallPolicyAssessmentOrBuilder getFirewallPolicyAssessmentOrBuilder()
       Output only. Assessment returned when firewall policies belonging to the
       project are evaluated using the field firewall_policy_evaluation.
       
      .google.cloud.recaptchaenterprise.v1.FirewallPolicyAssessment firewall_policy_assessment = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFirewallPolicyAssessmentOrBuilder in interface AssessmentOrBuilder
    • hasFraudPreventionAssessment

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

      public FraudPreventionAssessment getFraudPreventionAssessment()
       Output only. Assessment returned by Fraud Prevention when TransactionData
       is provided.
       
      .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFraudPreventionAssessment in interface AssessmentOrBuilder
      Returns:
      The fraudPreventionAssessment.
    • getFraudPreventionAssessmentOrBuilder

      public FraudPreventionAssessmentOrBuilder getFraudPreventionAssessmentOrBuilder()
       Output only. Assessment returned by Fraud Prevention when TransactionData
       is provided.
       
      .google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment fraud_prevention_assessment = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFraudPreventionAssessmentOrBuilder in interface AssessmentOrBuilder
    • hasFraudSignals

      public boolean hasFraudSignals()
       Output only. Fraud Signals specific to the users involved in a payment
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFraudSignals in interface AssessmentOrBuilder
      Returns:
      Whether the fraudSignals field is set.
    • getFraudSignals

      public FraudSignals getFraudSignals()
       Output only. Fraud Signals specific to the users involved in a payment
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFraudSignals in interface AssessmentOrBuilder
      Returns:
      The fraudSignals.
    • getFraudSignalsOrBuilder

      public FraudSignalsOrBuilder getFraudSignalsOrBuilder()
       Output only. Fraud Signals specific to the users involved in a payment
       transaction.
       
      .google.cloud.recaptchaenterprise.v1.FraudSignals fraud_signals = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFraudSignalsOrBuilder in interface AssessmentOrBuilder
    • hasPhoneFraudAssessment

      public boolean hasPhoneFraudAssessment()
       Output only. Assessment returned when a site key, a token, and a phone
       number as `user_id` are provided. Account defender and SMS toll fraud
       protection need to be enabled.
       
      .google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasPhoneFraudAssessment in interface AssessmentOrBuilder
      Returns:
      Whether the phoneFraudAssessment field is set.
    • getPhoneFraudAssessment

      public PhoneFraudAssessment getPhoneFraudAssessment()
       Output only. Assessment returned when a site key, a token, and a phone
       number as `user_id` are provided. Account defender and SMS toll fraud
       protection need to be enabled.
       
      .google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPhoneFraudAssessment in interface AssessmentOrBuilder
      Returns:
      The phoneFraudAssessment.
    • getPhoneFraudAssessmentOrBuilder

      public PhoneFraudAssessmentOrBuilder getPhoneFraudAssessmentOrBuilder()
       Output only. Assessment returned when a site key, a token, and a phone
       number as `user_id` are provided. Account defender and SMS toll fraud
       protection need to be enabled.
       
      .google.cloud.recaptchaenterprise.v1.PhoneFraudAssessment phone_fraud_assessment = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPhoneFraudAssessmentOrBuilder in interface AssessmentOrBuilder
    • hasAssessmentEnvironment

      public boolean hasAssessmentEnvironment()
       Optional. The environment creating the assessment. This describes your
       environment (the system invoking CreateAssessment), NOT the environment of
       your user.
       
      .google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAssessmentEnvironment in interface AssessmentOrBuilder
      Returns:
      Whether the assessmentEnvironment field is set.
    • getAssessmentEnvironment

      public AssessmentEnvironment getAssessmentEnvironment()
       Optional. The environment creating the assessment. This describes your
       environment (the system invoking CreateAssessment), NOT the environment of
       your user.
       
      .google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssessmentEnvironment in interface AssessmentOrBuilder
      Returns:
      The assessmentEnvironment.
    • getAssessmentEnvironmentOrBuilder

      public AssessmentEnvironmentOrBuilder getAssessmentEnvironmentOrBuilder()
       Optional. The environment creating the assessment. This describes your
       environment (the system invoking CreateAssessment), NOT the environment of
       your user.
       
      .google.cloud.recaptchaenterprise.v1.AssessmentEnvironment assessment_environment = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAssessmentEnvironmentOrBuilder 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