Package com.google.recaptchaenterprise.v1beta1

Class Event

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, Serializable
    public final class Event
extends com.google.protobuf.GeneratedMessageV3
implements EventOrBuilder
    Protobuf type google.cloud.recaptchaenterprise.v1beta1.Event
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Event.Builder
      Protobuf type google.cloud.recaptchaenterprise.v1beta1.Event

      • 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

    • Field Detail

      • USER_AGENT_FIELD_NUMBER

        public static final int USER_AGENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_IP_ADDRESS_FIELD_NUMBER

        public static final int USER_IP_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPECTED_ACTION_FIELD_NUMBER

        public static final int EXPECTED_ACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HASHED_ACCOUNT_ID_FIELD_NUMBER

        public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSACTION_DATA_FIELD_NUMBER

        public static final int TRANSACTION_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getToken

        public String getToken()
         Optional. The user response token provided by the reCAPTCHA Enterprise
 client-side integration on your site.
        string token = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getToken in interface EventOrBuilder
        Returns:
        The token.

      • getTokenBytes

        public com.google.protobuf.ByteString getTokenBytes()
         Optional. The user response token provided by the reCAPTCHA Enterprise
 client-side integration on your site.
        string token = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTokenBytes in interface EventOrBuilder
        Returns:
        The bytes for token.

      • getSiteKey

        public String getSiteKey()
         Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
 site and generate the token.
        string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSiteKey in interface EventOrBuilder
        Returns:
        The siteKey.

      • getSiteKeyBytes

        public com.google.protobuf.ByteString getSiteKeyBytes()
         Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
 site and generate the token.
        string site_key = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSiteKeyBytes in interface EventOrBuilder
        Returns:
        The bytes for siteKey.

      • getUserAgent

        public String getUserAgent()
         Optional. The user agent present in the request from the user's device
 related to this event.
        string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getUserAgent in interface EventOrBuilder
        Returns:
        The userAgent.

      • getUserAgentBytes

        public com.google.protobuf.ByteString getUserAgentBytes()
         Optional. The user agent present in the request from the user's device
 related to this event.
        string user_agent = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getUserAgentBytes in interface EventOrBuilder
        Returns:
        The bytes for userAgent.

      • getUserIpAddress

        public String getUserIpAddress()
         Optional. The IP address in the request from the user's device related to
 this event.
        string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getUserIpAddress in interface EventOrBuilder
        Returns:
        The userIpAddress.

      • getUserIpAddressBytes

        public com.google.protobuf.ByteString getUserIpAddressBytes()
         Optional. The IP address in the request from the user's device related to
 this event.
        string user_ip_address = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getUserIpAddressBytes in interface EventOrBuilder
        Returns:
        The bytes for userIpAddress.

      • getExpectedAction

        public String getExpectedAction()
         Optional. The expected action for this type of event. This should be the
 same action provided at token generation time on client-side platforms
 already integrated with recaptcha enterprise.
        string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExpectedAction in interface EventOrBuilder
        Returns:
        The expectedAction.

      • getExpectedActionBytes

        public com.google.protobuf.ByteString getExpectedActionBytes()
         Optional. The expected action for this type of event. This should be the
 same action provided at token generation time on client-side platforms
 already integrated with recaptcha enterprise.
        string expected_action = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExpectedActionBytes in interface EventOrBuilder
        Returns:
        The bytes for expectedAction.

      • getHashedAccountId

        public com.google.protobuf.ByteString getHashedAccountId()
         Optional. Unique stable hashed user identifier for the request. The
 identifier must be hashed using hmac-sha256 with stable secret.
        bytes hashed_account_id = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getHashedAccountId in interface EventOrBuilder
        Returns:
        The hashedAccountId.

      • hasTransactionData

        public boolean hasTransactionData()
         Optional. Data describing a payment transaction to be assessed. Sending
 this data enables reCAPTCHA Enterprise Fraud Prevention and the
 FraudPreventionAssessment component in the response.
        .google.cloud.recaptchaenterprise.v1beta1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasTransactionData in interface EventOrBuilder
        Returns:
        Whether the transactionData field is set.

      • getTransactionData

        public TransactionData getTransactionData()
         Optional. Data describing a payment transaction to be assessed. Sending
 this data enables reCAPTCHA Enterprise Fraud Prevention and the
 FraudPreventionAssessment component in the response.
        .google.cloud.recaptchaenterprise.v1beta1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTransactionData in interface EventOrBuilder
        Returns:
        The transactionData.

      • getTransactionDataOrBuilder

        public TransactionDataOrBuilder getTransactionDataOrBuilder()
         Optional. Data describing a payment transaction to be assessed. Sending
 this data enables reCAPTCHA Enterprise Fraud Prevention and the
 FraudPreventionAssessment component in the response.
        .google.cloud.recaptchaenterprise.v1beta1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTransactionDataOrBuilder in interface EventOrBuilder

      • 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 Event parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Event getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Event> 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 Event getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder