Class TokenProperties (3.64.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 3.64.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  TokenProperties   extends   GeneratedMessageV3   implements   TokenPropertiesOrBuilder  
   Properties of the provided event token.
 Protobuf type google.cloud.recaptchaenterprise.v1.TokenProperties
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  ACTION_FIELD_NUMBER 
  
    
public   static   final   int   ACTION_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  ANDROID_PACKAGE_NAME_FIELD_NUMBER 
  
    
public   static   final   int   ANDROID_PACKAGE_NAME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  CREATE_TIME_FIELD_NUMBER 
  
    
public   static   final   int   CREATE_TIME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  HOSTNAME_FIELD_NUMBER 
  
    
public   static   final   int   HOSTNAME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  INVALID_REASON_FIELD_NUMBER 
  
    
public   static   final   int   INVALID_REASON_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  IOS_BUNDLE_ID_FIELD_NUMBER 
  
    
public   static   final   int   IOS_BUNDLE_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  VALID_FIELD_NUMBER 
  
    
public   static   final   int   VALID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   TokenProperties   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   TokenProperties . Builder   newBuilder ()  
  
  newBuilder(TokenProperties prototype) 
  
    
public   static   TokenProperties . Builder   newBuilder ( TokenProperties   prototype )  
  
  
  
    
public   static   TokenProperties   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   TokenProperties   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   TokenProperties   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TokenProperties   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   TokenProperties   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TokenProperties   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   TokenProperties   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   TokenProperties   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   TokenProperties   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   TokenProperties   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   TokenProperties   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TokenProperties   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<TokenProperties>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getAction() 
  
    
public   String   getAction ()  
   Output only. Action name provided at token generation.
 string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    
      
        Returns  
      
        Type Description  
      
        String The action.
 
     
  
  getActionBytes() 
  
    
public   ByteString   getActionBytes ()  
   Output only. Action name provided at token generation.
 string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for action.
 
     
  
  getAndroidPackageName() 
  
    
public   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  
      
        Type Description  
      
        String The androidPackageName.
 
     
  
  getAndroidPackageNameBytes() 
  
    
public   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  
      
        Type Description  
      
        ByteString The bytes for androidPackageName.
 
     
  
  getCreateTime() 
  
    
public   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  
      
        Type Description  
      
        Timestamp The createTime.
 
     
  
  getCreateTimeOrBuilder() 
  
    
public   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];
 
getDefaultInstanceForType() 
  
    
public   TokenProperties   getDefaultInstanceForType ()  
  
  getHostname() 
  
    
public   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  
      
        Type Description  
      
        String The hostname.
 
     
  
  getHostnameBytes() 
  
    
public   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  
      
        Type Description  
      
        ByteString The bytes for hostname.
 
     
  
  getInvalidReason() 
  
    
public   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];
 
getInvalidReasonValue() 
  
    
public   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  
      
        Type Description  
      
        int The enum numeric value on the wire for invalidReason.
 
     
  
  getIosBundleId() 
  
    
public   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  
      
        Type Description  
      
        String The iosBundleId.
 
     
  
  getIosBundleIdBytes() 
  
    
public   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  
      
        Type Description  
      
        ByteString The bytes for iosBundleId.
 
     
  
  getParserForType() 
  
    
public   Parser<TokenProperties>   getParserForType ()  
  
  Overrides 
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getValid() 
  
    
public   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  
      
        Type Description  
      
        boolean The valid.
 
     
  
  hasCreateTime() 
  
    
public   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  
      
        Type Description  
      
        boolean Whether the createTime field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   TokenProperties . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   TokenProperties . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   TokenProperties . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]