Interface AnnotateAssessmentRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AnnotateAssessmentRequest,AnnotateAssessmentRequest.Builder
@Generated
public interface AnnotateAssessmentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionOptional.com.google.protobuf.ByteStringOptional.Optional.intOptional.com.google.protobuf.ByteStringOptional.getName()Required.com.google.protobuf.ByteStringRequired.Optional.Optional.getReasons(int index) Optional.intOptional.Optional.intgetReasonsValue(int index) Optional.Optional.Optional.Optional.booleanOptional.booleanOptional.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
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 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:
- The enum numeric value on the wire for annotation.
-
getAnnotation
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];- Returns:
- The annotation.
-
getReasonsList
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];- Returns:
- A list containing the reasons.
-
getReasonsCount
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];- Returns:
- The count of reasons.
-
getReasons
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 of the element to return.- Returns:
- The reasons at the given index.
-
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];- Returns:
- A list containing the enum numeric values on the wire for reasons.
-
getReasonsValue
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];- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of reasons at the given index.
-
getAccountId
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];- Returns:
- The accountId.
-
getAccountIdBytes
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];- Returns:
- The bytes for accountId.
-
getHashedAccountId
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];- 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]; -
hasPhoneAuthenticationEvent
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];- Returns:
- Whether the phoneAuthenticationEvent field is set.
-
getPhoneAuthenticationEvent
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];- Returns:
- The phoneAuthenticationEvent.
-
getPhoneAuthenticationEventOrBuilder
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];
-