Class Event

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.Event
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, Serializable

@Generated public final class Event extends com.google.protobuf.GeneratedMessage implements EventOrBuilder
 The event being assessed.
 
Protobuf type google.cloud.recaptchaenterprise.v1.Event
See Also:
  • Field Details

    • TOKEN_FIELD_NUMBER

      public static final int TOKEN_FIELD_NUMBER
      See Also:
    • SITE_KEY_FIELD_NUMBER

      public static final int SITE_KEY_FIELD_NUMBER
      See Also:
    • USER_AGENT_FIELD_NUMBER

      public static final int USER_AGENT_FIELD_NUMBER
      See Also:
    • USER_IP_ADDRESS_FIELD_NUMBER

      public static final int USER_IP_ADDRESS_FIELD_NUMBER
      See Also:
    • EXPECTED_ACTION_FIELD_NUMBER

      public static final int EXPECTED_ACTION_FIELD_NUMBER
      See Also:
    • HASHED_ACCOUNT_ID_FIELD_NUMBER

      public static final int HASHED_ACCOUNT_ID_FIELD_NUMBER
      See Also:
    • EXPRESS_FIELD_NUMBER

      public static final int EXPRESS_FIELD_NUMBER
      See Also:
    • REQUESTED_URI_FIELD_NUMBER

      public static final int REQUESTED_URI_FIELD_NUMBER
      See Also:
    • WAF_TOKEN_ASSESSMENT_FIELD_NUMBER

      public static final int WAF_TOKEN_ASSESSMENT_FIELD_NUMBER
      See Also:
    • JA3_FIELD_NUMBER

      public static final int JA3_FIELD_NUMBER
      See Also:
    • JA4_FIELD_NUMBER

      public static final int JA4_FIELD_NUMBER
      See Also:
    • HEADERS_FIELD_NUMBER

      public static final int HEADERS_FIELD_NUMBER
      See Also:
    • FIREWALL_POLICY_EVALUATION_FIELD_NUMBER

      public static final int FIREWALL_POLICY_EVALUATION_FIELD_NUMBER
      See Also:
    • TRANSACTION_DATA_FIELD_NUMBER

      public static final int TRANSACTION_DATA_FIELD_NUMBER
      See Also:
    • USER_INFO_FIELD_NUMBER

      public static final int USER_INFO_FIELD_NUMBER
      See Also:
    • FRAUD_PREVENTION_FIELD_NUMBER

      public static final int FRAUD_PREVENTION_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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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, (.google.api.field_info) = { ... }
      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, (.google.api.field_info) = { ... }
      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

      @Deprecated public com.google.protobuf.ByteString getHashedAccountId()
      Deprecated.
      google.cloud.recaptchaenterprise.v1.Event.hashed_account_id is deprecated. See google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto;l=765
       Optional. Deprecated: use `user_info.account_id` instead.
       Unique stable hashed user identifier for the request. The identifier must
       be hashed using hmac-sha256 with stable secret.
       
      bytes hashed_account_id = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHashedAccountId in interface EventOrBuilder
      Returns:
      The hashedAccountId.
    • getExpress

      public boolean getExpress()
       Optional. Flag for a reCAPTCHA express request for an assessment without a
       token. If enabled, `site_key` must reference an Express site key.
       
      bool express = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpress in interface EventOrBuilder
      Returns:
      The express.
    • getRequestedUri

      public String getRequestedUri()
       Optional. The URI resource the user requested that triggered an assessment.
       
      string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedUri in interface EventOrBuilder
      Returns:
      The requestedUri.
    • getRequestedUriBytes

      public com.google.protobuf.ByteString getRequestedUriBytes()
       Optional. The URI resource the user requested that triggered an assessment.
       
      string requested_uri = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRequestedUriBytes in interface EventOrBuilder
      Returns:
      The bytes for requestedUri.
    • getWafTokenAssessment

      public boolean getWafTokenAssessment()
       Optional. Flag for running Web Application Firewall (WAF) token assessment.
       If enabled, the token must be specified, and have been created by a
       WAF-enabled key.
       
      bool waf_token_assessment = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWafTokenAssessment in interface EventOrBuilder
      Returns:
      The wafTokenAssessment.
    • getJa3

      public String getJa3()
       Optional. JA3 fingerprint for SSL clients. To learn how to compute this
       fingerprint, please refer to https://github.com/salesforce/ja3.
       
      string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJa3 in interface EventOrBuilder
      Returns:
      The ja3.
    • getJa3Bytes

      public com.google.protobuf.ByteString getJa3Bytes()
       Optional. JA3 fingerprint for SSL clients. To learn how to compute this
       fingerprint, please refer to https://github.com/salesforce/ja3.
       
      string ja3 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJa3Bytes in interface EventOrBuilder
      Returns:
      The bytes for ja3.
    • getJa4

      public String getJa4()
       Optional. JA4 fingerprint for SSL clients. To learn how to compute this
       fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
       
      string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJa4 in interface EventOrBuilder
      Returns:
      The ja4.
    • getJa4Bytes

      public com.google.protobuf.ByteString getJa4Bytes()
       Optional. JA4 fingerprint for SSL clients. To learn how to compute this
       fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
       
      string ja4 = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getJa4Bytes in interface EventOrBuilder
      Returns:
      The bytes for ja4.
    • getHeadersList

      public com.google.protobuf.ProtocolStringList getHeadersList()
       Optional. HTTP header information about the request.
       
      repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeadersList in interface EventOrBuilder
      Returns:
      A list containing the headers.
    • getHeadersCount

      public int getHeadersCount()
       Optional. HTTP header information about the request.
       
      repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeadersCount in interface EventOrBuilder
      Returns:
      The count of headers.
    • getHeaders

      public String getHeaders(int index)
       Optional. HTTP header information about the request.
       
      repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeaders in interface EventOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The headers at the given index.
    • getHeadersBytes

      public com.google.protobuf.ByteString getHeadersBytes(int index)
       Optional. HTTP header information about the request.
       
      repeated string headers = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHeadersBytes in interface EventOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the headers at the given index.
    • getFirewallPolicyEvaluation

      public boolean getFirewallPolicyEvaluation()
       Optional. Flag for enabling firewall policy config assessment.
       If this flag is enabled, the firewall policy is evaluated and a
       suggested firewall action is returned in the response.
       
      bool firewall_policy_evaluation = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFirewallPolicyEvaluation in interface EventOrBuilder
      Returns:
      The firewallPolicyEvaluation.
    • 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.v1.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.v1.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.v1.TransactionData transaction_data = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTransactionDataOrBuilder in interface EventOrBuilder
    • hasUserInfo

      public boolean hasUserInfo()
       Optional. Information about the user that generates this event, when they
       can be identified. They are often identified through the use of an account
       for logged-in requests or login/registration requests, or by providing user
       identifiers for guest actions like checkout.
       
      .google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUserInfo in interface EventOrBuilder
      Returns:
      Whether the userInfo field is set.
    • getUserInfo

      public UserInfo getUserInfo()
       Optional. Information about the user that generates this event, when they
       can be identified. They are often identified through the use of an account
       for logged-in requests or login/registration requests, or by providing user
       identifiers for guest actions like checkout.
       
      .google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfo in interface EventOrBuilder
      Returns:
      The userInfo.
    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       Optional. Information about the user that generates this event, when they
       can be identified. They are often identified through the use of an account
       for logged-in requests or login/registration requests, or by providing user
       identifiers for guest actions like checkout.
       
      .google.cloud.recaptchaenterprise.v1.UserInfo user_info = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfoOrBuilder in interface EventOrBuilder
    • getFraudPreventionValue

      public int getFraudPreventionValue()
       Optional. The Fraud Prevention setting for this assessment.
       
      .google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFraudPreventionValue in interface EventOrBuilder
      Returns:
      The enum numeric value on the wire for fraudPrevention.
    • getFraudPrevention

      public Event.FraudPrevention getFraudPrevention()
       Optional. The Fraud Prevention setting for this assessment.
       
      .google.cloud.recaptchaenterprise.v1.Event.FraudPrevention fraud_prevention = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFraudPrevention in interface EventOrBuilder
      Returns:
      The fraudPrevention.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Event parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Event parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static Event parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static Event parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • 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
    • newBuilder

      public static Event.Builder newBuilder()
    • newBuilder

      public static Event.Builder newBuilder(Event prototype)
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

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