Class TokenProperties (2.3.1)

public final class TokenProperties extends GeneratedMessageV3 implements TokenPropertiesOrBuilder

Protobuf type google.cloud.recaptchaenterprise.v1.TokenProperties

Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

HOSTNAME_FIELD_NUMBER

public static final int HOSTNAME_FIELD_NUMBER
Field Value
TypeDescription
int

INVALID_REASON_FIELD_NUMBER

public static final int INVALID_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

VALID_FIELD_NUMBER

public static final int VALID_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAction()

public String getAction()

Action name provided at token generation.

string action = 5;

Returns
TypeDescription
String

The action.

getActionBytes()

public ByteString getActionBytes()

Action name provided at token generation.

string action = 5;

Returns
TypeDescription
ByteString

The bytes for action.

getCreateTime()

public Timestamp getCreateTime()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static TokenProperties getDefaultInstance()
Returns
TypeDescription
TokenProperties

getDefaultInstanceForType()

public TokenProperties getDefaultInstanceForType()
Returns
TypeDescription
TokenProperties

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getHostname()

public String getHostname()

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

string hostname = 4;

Returns
TypeDescription
String

The hostname.

getHostnameBytes()

public ByteString getHostnameBytes()

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

string hostname = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for invalidReason.

getParserForType()

public Parser<TokenProperties> getParserForType()
Returns
TypeDescription
Parser<TokenProperties>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

The valid.

hasCreateTime()

public boolean hasCreateTime()

The timestamp corresponding to the generation of the token.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static TokenProperties.Builder newBuilder()
Returns
TypeDescription
TokenProperties.Builder

newBuilder(TokenProperties prototype)

public static TokenProperties.Builder newBuilder(TokenProperties prototype)
Parameter
NameDescription
prototypeTokenProperties
Returns
TypeDescription
TokenProperties.Builder

newBuilderForType()

public TokenProperties.Builder newBuilderForType()
Returns
TypeDescription
TokenProperties.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TokenProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TokenProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static TokenProperties parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TokenProperties parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TokenProperties parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TokenProperties parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TokenProperties parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TokenProperties parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TokenProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TokenProperties
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TokenProperties> parser()
Returns
TypeDescription
Parser<TokenProperties>

toBuilder()

public TokenProperties.Builder toBuilder()
Returns
TypeDescription
TokenProperties.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException