Interface TokenPropertiesOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TokenProperties, TokenProperties.Builder

@Generated public interface TokenPropertiesOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getValid

      boolean getValid()
       Output only. Whether the provided user response token is valid. When valid
       = false, the reason could be specified in invalid_reason or it could also
       be due to a user failing to solve a challenge or a sitekey mismatch (i.e
       the sitekey used to generate the token was different than the one specified
       in the assessment).
       
      bool valid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The valid.
    • getInvalidReasonValue

      int getInvalidReasonValue()
       Output only. Reason associated with the response when valid = false.
       
      .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for invalidReason.
    • getInvalidReason

      TokenProperties.InvalidReason getInvalidReason()
       Output only. Reason associated with the response when valid = false.
       
      .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The invalidReason.
    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp corresponding to the generation of the token.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp corresponding to the generation of the token.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp corresponding to the generation of the token.
       
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getHostname

      String getHostname()
       Output only. The hostname of the page on which the token was generated (Web
       keys only).
       
      string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The hostname.
    • getHostnameBytes

      com.google.protobuf.ByteString getHostnameBytes()
       Output only. The hostname of the page on which the token was generated (Web
       keys only).
       
      string hostname = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for hostname.
    • getAndroidPackageName

      String getAndroidPackageName()
       Output only. The name of the Android package with which the token was
       generated (Android keys only).
       
      string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The androidPackageName.
    • getAndroidPackageNameBytes

      com.google.protobuf.ByteString getAndroidPackageNameBytes()
       Output only. The name of the Android package with which the token was
       generated (Android keys only).
       
      string android_package_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for androidPackageName.
    • getIosBundleId

      String getIosBundleId()
       Output only. The ID of the iOS bundle with which the token was generated
       (iOS keys only).
       
      string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The iosBundleId.
    • getIosBundleIdBytes

      com.google.protobuf.ByteString getIosBundleIdBytes()
       Output only. The ID of the iOS bundle with which the token was generated
       (iOS keys only).
       
      string ios_bundle_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for iosBundleId.
    • getAction

      String getAction()
       Output only. Action name provided at token generation.
       
      string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The action.
    • getActionBytes

      com.google.protobuf.ByteString getActionBytes()
       Output only. Action name provided at token generation.
       
      string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for action.