/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto
package com.google.recaptchaenterprise.v1beta1;
public interface AssessmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.recaptchaenterprise.v1beta1.Assessment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The event being assessed.
*
*
* .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
*
* @return Whether the event field is set.
*/
boolean hasEvent();
/**
*
*
*
* The event being assessed.
*
*
* .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
*
* @return The event.
*/
com.google.recaptchaenterprise.v1beta1.Event getEvent();
/**
*
*
*
* The event being assessed.
*
*
* .google.cloud.recaptchaenterprise.v1beta1.Event event = 2;
*/
com.google.recaptchaenterprise.v1beta1.EventOrBuilder getEventOrBuilder();
/**
*
*
*
* 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];
*
* @return The score.
*/
float getScore();
/**
*
*
*
* Output only. Properties of the provided event token.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the tokenProperties field is set.
*/
boolean hasTokenProperties();
/**
*
*
*
* Output only. Properties of the provided event token.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The tokenProperties.
*/
com.google.recaptchaenterprise.v1beta1.TokenProperties getTokenProperties();
/**
*
*
*
* Output only. Properties of the provided event token.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.TokenProperties token_properties = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.recaptchaenterprise.v1beta1.TokenPropertiesOrBuilder getTokenPropertiesOrBuilder();
/**
*
*
*
* Output only. Reasons contributing to the risk analysis verdict.
*
*
*
* repeated .google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason reasons = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return A list containing the reasons.
*/
java.util.List
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];
*
*
* @return The count of reasons.
*/
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];
*
*
* @param index The index of the element to return.
* @return The reasons at the given index.
*/
com.google.recaptchaenterprise.v1beta1.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];
*
*
* @return A list containing the enum numeric values on the wire for reasons.
*/
java.util.List 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];
*
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of reasons at the given index.
*/
int getReasonsValue(int index);
/**
*
*
*
* 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;
*
*
* @return Whether the passwordLeakVerification field is set.
*/
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;
*
*
* @return The passwordLeakVerification.
*/
com.google.recaptchaenterprise.v1beta1.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;
*
*/
com.google.recaptchaenterprise.v1beta1.PasswordLeakVerificationOrBuilder
getPasswordLeakVerificationOrBuilder();
/**
*
*
*
* Assessment returned by account defender when a hashed_account_id is
* provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
*
*
* @return Whether the accountDefenderAssessment field is set.
*/
boolean hasAccountDefenderAssessment();
/**
*
*
*
* Assessment returned by account defender when a hashed_account_id is
* provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
*
*
* @return The accountDefenderAssessment.
*/
com.google.recaptchaenterprise.v1beta1.AccountDefenderAssessment getAccountDefenderAssessment();
/**
*
*
*
* Assessment returned by account defender when a hashed_account_id is
* provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment account_defender_assessment = 8;
*
*/
com.google.recaptchaenterprise.v1beta1.AccountDefenderAssessmentOrBuilder
getAccountDefenderAssessmentOrBuilder();
/**
*
*
*
* Assessment returned by Fraud Prevention when TransactionData is provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
*
*
* @return Whether the fraudPreventionAssessment field is set.
*/
boolean hasFraudPreventionAssessment();
/**
*
*
*
* Assessment returned by Fraud Prevention when TransactionData is provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
*
*
* @return The fraudPreventionAssessment.
*/
com.google.recaptchaenterprise.v1beta1.FraudPreventionAssessment getFraudPreventionAssessment();
/**
*
*
*
* Assessment returned by Fraud Prevention when TransactionData is provided.
*
*
*
* .google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment fraud_prevention_assessment = 11;
*
*/
com.google.recaptchaenterprise.v1beta1.FraudPreventionAssessmentOrBuilder
getFraudPreventionAssessmentOrBuilder();
}