Package com.google.recaptchaenterprise.v1

Class TokenProperties

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TokenPropertiesOrBuilder, Serializable
    public final class TokenProperties
extends com.google.protobuf.GeneratedMessageV3
implements TokenPropertiesOrBuilder
     Properties of the provided event token.
    Protobuf type google.cloud.recaptchaenterprise.v1.TokenProperties
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TokenProperties.Builder
      Properties of the provided event token.
      static class  TokenProperties.InvalidReason
      Enum that represents the types of invalid token reasons.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getValid in interface TokenPropertiesOrBuilder
        Returns:
        The valid.

      • getInvalidReasonValue

        public int getInvalidReasonValue()
         Reason associated with the response when valid = false.
        .google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason invalid_reason = 2;
        Specified by:
        getInvalidReasonValue in interface TokenPropertiesOrBuilder
        Returns:
        The enum numeric value on the wire for invalidReason.

      • hasCreateTime

        public boolean hasCreateTime()
         The timestamp corresponding to the generation of the token.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        hasCreateTime in interface TokenPropertiesOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The timestamp corresponding to the generation of the token.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        getCreateTime in interface TokenPropertiesOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The timestamp corresponding to the generation of the token.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        getCreateTimeOrBuilder in interface TokenPropertiesOrBuilder

      • getHostname

        public String getHostname()
         The hostname of the page on which the token was generated (Web keys only).
        string hostname = 4;
        Specified by:
        getHostname in interface TokenPropertiesOrBuilder
        Returns:
        The hostname.

      • getHostnameBytes

        public com.google.protobuf.ByteString getHostnameBytes()
         The hostname of the page on which the token was generated (Web keys only).
        string hostname = 4;
        Specified by:
        getHostnameBytes in interface TokenPropertiesOrBuilder
        Returns:
        The bytes for hostname.

      • getAndroidPackageName

        public String getAndroidPackageName()
         The name of the Android package with which the token was generated (Android
 keys only).
        string android_package_name = 8;
        Specified by:
        getAndroidPackageName in interface TokenPropertiesOrBuilder
        Returns:
        The androidPackageName.

      • getAndroidPackageNameBytes

        public com.google.protobuf.ByteString getAndroidPackageNameBytes()
         The name of the Android package with which the token was generated (Android
 keys only).
        string android_package_name = 8;
        Specified by:
        getAndroidPackageNameBytes in interface TokenPropertiesOrBuilder
        Returns:
        The bytes for androidPackageName.

      • getIosBundleId

        public String getIosBundleId()
         The ID of the iOS bundle with which the token was generated (iOS keys
 only).
        string ios_bundle_id = 9;
        Specified by:
        getIosBundleId in interface TokenPropertiesOrBuilder
        Returns:
        The iosBundleId.

      • getIosBundleIdBytes

        public com.google.protobuf.ByteString getIosBundleIdBytes()
         The ID of the iOS bundle with which the token was generated (iOS keys
 only).
        string ios_bundle_id = 9;
        Specified by:
        getIosBundleIdBytes in interface TokenPropertiesOrBuilder
        Returns:
        The bytes for iosBundleId.

      • getActionBytes

        public com.google.protobuf.ByteString getActionBytes()
         Action name provided at token generation.
        string action = 5;
        Specified by:
        getActionBytes in interface TokenPropertiesOrBuilder
        Returns:
        The bytes for action.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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

        public static TokenProperties parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TokenProperties.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TokenProperties.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TokenProperties.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<TokenProperties> parser()

      • getParserForType

        public com.google.protobuf.Parser<TokenProperties> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TokenProperties getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder