Interface TokenPropertiesOrBuilder (3.33.0)

public interface TokenPropertiesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAction()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

getHostname()

public abstract 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 abstract 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 abstract 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
Type	Description
`TokenProperties.InvalidReason`	The invalidReason.

getInvalidReasonValue()

public abstract 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 abstract 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 abstract 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.

getValid()

public abstract 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 abstract 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.