Class TokenProperties (3.27.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

Implements

TokenPropertiesOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

getAction()

public String getAction()

Action name provided at token generation.

string action = 5;

Returns
Type	Description
`String`	The action.

getActionBytes()

public ByteString getActionBytes()

Action name provided at token generation.

string action = 5;

Returns
Type	Description
`ByteString`	The bytes for action.

getAndroidPackageName()

public 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 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 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 TimestampOrBuilder getCreateTimeOrBuilder()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public TokenProperties getDefaultInstanceForType()

Returns
Type	Description
`TokenProperties`

getHostname()

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

getParserForType()

public Parser<TokenProperties> getParserForType()

Returns
Type	Description
`Parser<TokenProperties>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getValid()

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TokenProperties.Builder toBuilder()

Returns
Type	Description
`TokenProperties.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`