Class TokenProperties
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.TokenProperties
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,TokenPropertiesOrBuilder,Serializable
@Generated
public final class TokenProperties
extends com.google.protobuf.GeneratedMessage
implements TokenPropertiesOrBuilder
Properties of the provided event token.Protobuf type
google.cloud.recaptchaenterprise.v1.TokenProperties- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProperties of the provided event token.static enumEnum that represents the types of invalid token reasons.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanOutput only.com.google.protobuf.ByteStringOutput only.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static TokenPropertiesstatic final com.google.protobuf.Descriptors.DescriptorOutput only.com.google.protobuf.ByteStringOutput only.Output only.intOutput only.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.Parser<TokenProperties>intbooleangetValid()Output only.booleanOutput only.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic TokenProperties.Builderstatic TokenProperties.BuildernewBuilder(TokenProperties prototype) protected TokenProperties.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static TokenPropertiesparseDelimitedFrom(InputStream input) static TokenPropertiesparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenPropertiesparseFrom(byte[] data) static TokenPropertiesparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenPropertiesparseFrom(com.google.protobuf.ByteString data) static TokenPropertiesparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenPropertiesparseFrom(com.google.protobuf.CodedInputStream input) static TokenPropertiesparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenPropertiesparseFrom(InputStream input) static TokenPropertiesparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TokenPropertiesparseFrom(ByteBuffer data) static TokenPropertiesparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<TokenProperties>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
VALID_FIELD_NUMBER
public static final int VALID_FIELD_NUMBER- See Also:
-
INVALID_REASON_FIELD_NUMBER
public static final int INVALID_REASON_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
HOSTNAME_FIELD_NUMBER
public static final int HOSTNAME_FIELD_NUMBER- See Also:
-
ANDROID_PACKAGE_NAME_FIELD_NUMBER
public static final int ANDROID_PACKAGE_NAME_FIELD_NUMBER- See Also:
-
IOS_BUNDLE_ID_FIELD_NUMBER
public static final int IOS_BUNDLE_ID_FIELD_NUMBER- See Also:
-
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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];- Specified by:
getValidin interfaceTokenPropertiesOrBuilder- Returns:
- The valid.
-
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];- Specified by:
getInvalidReasonValuein interfaceTokenPropertiesOrBuilder- Returns:
- The enum numeric value on the wire for 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];- Specified by:
getInvalidReasonin interfaceTokenPropertiesOrBuilder- Returns:
- The invalidReason.
-
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];- Specified by:
hasCreateTimein interfaceTokenPropertiesOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.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];- Specified by:
getCreateTimein interfaceTokenPropertiesOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getCreateTimeOrBuilderin interfaceTokenPropertiesOrBuilder
-
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];- Specified by:
getHostnamein interfaceTokenPropertiesOrBuilder- Returns:
- The hostname.
-
getHostnameBytes
public com.google.protobuf.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];- Specified by:
getHostnameBytesin interfaceTokenPropertiesOrBuilder- Returns:
- The bytes for hostname.
-
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];- Specified by:
getAndroidPackageNamein interfaceTokenPropertiesOrBuilder- Returns:
- The androidPackageName.
-
getAndroidPackageNameBytes
public com.google.protobuf.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];- Specified by:
getAndroidPackageNameBytesin interfaceTokenPropertiesOrBuilder- Returns:
- The bytes for androidPackageName.
-
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];- Specified by:
getIosBundleIdin interfaceTokenPropertiesOrBuilder- Returns:
- The iosBundleId.
-
getIosBundleIdBytes
public com.google.protobuf.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];- Specified by:
getIosBundleIdBytesin interfaceTokenPropertiesOrBuilder- Returns:
- The bytes for iosBundleId.
-
getAction
Output only. Action name provided at token generation.
string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getActionin interfaceTokenPropertiesOrBuilder- Returns:
- The action.
-
getActionBytes
public com.google.protobuf.ByteString getActionBytes()Output only. Action name provided at token generation.
string action = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getActionBytesin interfaceTokenPropertiesOrBuilder- Returns:
- The bytes for action.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static TokenProperties parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenProperties parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenProperties parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenProperties parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenProperties parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static TokenProperties parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static TokenProperties parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static TokenProperties parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static TokenProperties parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static TokenProperties parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected TokenProperties.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-