- 3.75.0 (latest)
 - 3.73.0
 - 3.72.0
 - 3.71.0
 - 3.70.0
 - 3.69.0
 - 3.67.0
 - 3.65.0
 - 3.64.0
 - 3.61.0
 - 3.60.0
 - 3.59.0
 - 3.57.0
 - 3.56.0
 - 3.55.0
 - 3.54.0
 - 3.53.0
 - 3.52.0
 - 3.51.0
 - 3.50.0
 - 3.49.0
 - 3.48.0
 - 3.46.0
 - 3.45.0
 - 3.44.0
 - 3.43.0
 - 3.42.0
 - 3.41.0
 - 3.40.0
 - 3.39.0
 - 3.38.0
 - 3.37.0
 - 3.36.0
 - 3.34.0
 - 3.33.0
 - 3.32.0
 - 3.31.0
 - 3.30.0
 - 3.29.0
 - 3.28.0
 - 3.27.0
 - 3.26.0
 - 3.25.0
 - 3.24.0
 - 3.21.0
 - 3.20.0
 - 3.19.0
 - 3.18.0
 - 3.17.0
 - 3.16.0
 - 3.15.0
 - 3.14.0
 - 3.13.0
 - 3.12.0
 - 3.11.0
 - 3.10.0
 - 3.9.0
 - 3.8.0
 - 3.6.0
 - 3.5.0
 - 3.4.0
 - 3.3.0
 - 3.2.0
 - 3.1.0
 - 3.0.12
 - 2.6.1
 - 2.5.0
 - 2.4.10
 - 2.3.1
 
public interface TokenPropertiesOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAction()
public abstract String getAction()Action name provided at token generation.
 string action = 5;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The action.  | 
      
getActionBytes()
public abstract ByteString getActionBytes()Action name provided at token generation.
 string action = 5;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for action.  | 
      
getAndroidPackageName()
public abstract String getAndroidPackageName()The name of the Android package with which the token was generated (Android keys only).
 string android_package_name = 8;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The androidPackageName.  | 
      
getAndroidPackageNameBytes()
public abstract ByteString getAndroidPackageNameBytes()The name of the Android package with which the token was generated (Android keys only).
 string android_package_name = 8;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for androidPackageName.  | 
      
getCreateTime()
public abstract Timestamp getCreateTime()The timestamp corresponding to the generation of the token.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The createTime.  | 
      
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()The timestamp corresponding to the generation of the token.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
getHostname()
public abstract String getHostname()The hostname of the page on which the token was generated (Web keys only).
 string hostname = 4;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The hostname.  | 
      
getHostnameBytes()
public abstract ByteString getHostnameBytes()The hostname of the page on which the token was generated (Web keys only).
 string hostname = 4;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for hostname.  | 
      
getInvalidReason()
public abstract TokenProperties.InvalidReason getInvalidReason()Reason associated with the response when valid = false.
 .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;
 
| Returns | |
|---|---|
| Type | Description | 
TokenProperties.InvalidReason | 
        The invalidReason.  | 
      
getInvalidReasonValue()
public abstract int getInvalidReasonValue()Reason associated with the response when valid = false.
 .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        The enum numeric value on the wire for invalidReason.  | 
      
getIosBundleId()
public abstract String getIosBundleId()The ID of the iOS bundle with which the token was generated (iOS keys only).
 string ios_bundle_id = 9;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The iosBundleId.  | 
      
getIosBundleIdBytes()
public abstract ByteString getIosBundleIdBytes()The ID of the iOS bundle with which the token was generated (iOS keys only).
 string ios_bundle_id = 9;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for iosBundleId.  | 
      
getValid()
public abstract boolean getValid()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;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The valid.  | 
      
hasCreateTime()
public abstract boolean hasCreateTime()The timestamp corresponding to the generation of the token.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the createTime field is set.  |