com.google.recaptchaenterprise.v1

Interface TokenPropertiesOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TokenProperties, TokenProperties.Builder

public interface TokenPropertiesOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAction() Action name provided at token generation.
com.google.protobuf.ByteString	getActionBytes() Action name provided at token generation.
com.google.protobuf.Timestamp	getCreateTime() The timestamp corresponding to the generation of the token.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The timestamp corresponding to the generation of the token.
String	getHostname() The hostname of the page on which the token was generated.
com.google.protobuf.ByteString	getHostnameBytes() The hostname of the page on which the token was generated.
TokenProperties.InvalidReason	getInvalidReason() Reason associated with the response when valid = false.
int	getInvalidReasonValue() Reason associated with the response when valid = false.
boolean	getValid() Whether the provided user response token is valid.
boolean	hasCreateTime() The timestamp corresponding to the generation of the token.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getValid

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:

The valid.

getInvalidReasonValue

int getInvalidReasonValue()

 Reason associated with the response when valid = false.
 

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Returns:

The enum numeric value on the wire for invalidReason.

getInvalidReason

TokenProperties.InvalidReason getInvalidReason()

 Reason associated with the response when valid = false.
 

.google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;

Returns:

The invalidReason.

hasCreateTime

boolean hasCreateTime()

 The timestamp corresponding to the generation of the token.
 

.google.protobuf.Timestamp create_time = 3;

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 The timestamp corresponding to the generation of the token.
 

.google.protobuf.Timestamp create_time = 3;

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The timestamp corresponding to the generation of the token.
 

.google.protobuf.Timestamp create_time = 3;

getHostname

String getHostname()

 The hostname of the page on which the token was generated.
 

string hostname = 4;

Returns:

The hostname.

getHostnameBytes

com.google.protobuf.ByteString getHostnameBytes()

 The hostname of the page on which the token was generated.
 

string hostname = 4;

Returns:

The bytes for hostname.

getAction

String getAction()

 Action name provided at token generation.
 

string action = 5;

Returns:

The action.

getActionBytes

com.google.protobuf.ByteString getActionBytes()

 Action name provided at token generation.
 

string action = 5;

Returns:

The bytes for action.