Class TokenProperties (3.40.0) 

public final class TokenProperties extends GeneratedMessageV3 implements TokenPropertiesOrBuilder

Properties of the provided event token.

Protobuf type google.cloud.recaptchaenterprise.v1.TokenProperties

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TokenProperties

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()
Returns
Type Description
TokenProperties

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TokenProperties.Builder newBuilder()
Returns
Type Description
TokenProperties.Builder

newBuilder(TokenProperties prototype)

public static TokenProperties.Builder newBuilder(TokenProperties prototype)
Parameter
Name Description
prototype TokenProperties
Returns
Type Description
TokenProperties.Builder

parseDelimitedFrom(InputStream input)

public static TokenProperties parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TokenProperties parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TokenProperties parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TokenProperties parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TokenProperties parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TokenProperties parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TokenProperties
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TokenProperties> parser()
Returns
Type Description
Parser<TokenProperties>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TokenProperties getDefaultInstanceForType()
Returns
Type Description
TokenProperties

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

Returns
Type Description
TokenProperties.InvalidReason

The invalidReason.

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()
Returns
Type Description
Parser<TokenProperties>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TokenProperties.Builder newBuilderForType()
Returns
Type Description
TokenProperties.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TokenProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TokenProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TokenProperties.Builder toBuilder()
Returns
Type Description
TokenProperties.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException