Class CollectUserEventRequest

  • All Implemented Interfaces:
    CollectUserEventRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CollectUserEventRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CollectUserEventRequestOrBuilder
     Request message for CollectUserEvent method.
     
    Protobuf type google.cloud.discoveryengine.v1beta.CollectUserEventRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CollectUserEventRequest.Builder
      Request message for CollectUserEvent method.
      • 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 Summary

      Fields 
      Modifier and Type Field Description
      static int ETS_FIELD_NUMBER  
      static int PARENT_FIELD_NUMBER  
      static int URI_FIELD_NUMBER  
      static int USER_EVENT_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • 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
      • getParent

        public String getParent()
         Required. The parent DataStore resource name, such as
         `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface CollectUserEventRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent DataStore resource name, such as
         `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for parent.
      • getUserEvent

        public String getUserEvent()
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
         characters.
         
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEvent in interface CollectUserEventRequestOrBuilder
        Returns:
        The userEvent.
      • getUserEventBytes

        public com.google.protobuf.ByteString getUserEventBytes()
         Required. URL encoded UserEvent proto with a length limit of 2,000,000
         characters.
         
        string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUserEventBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for userEvent.
      • hasUri

        public boolean hasUri()
         The URL including cgi-parameters but excluding the hash fragment with a
         length limit of 5,000 characters. This is often more useful than the
         referer URL, because many browsers only send the domain for third-party
         requests.
         
        optional string uri = 3;
        Specified by:
        hasUri in interface CollectUserEventRequestOrBuilder
        Returns:
        Whether the uri field is set.
      • getUri

        public String getUri()
         The URL including cgi-parameters but excluding the hash fragment with a
         length limit of 5,000 characters. This is often more useful than the
         referer URL, because many browsers only send the domain for third-party
         requests.
         
        optional string uri = 3;
        Specified by:
        getUri in interface CollectUserEventRequestOrBuilder
        Returns:
        The uri.
      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         The URL including cgi-parameters but excluding the hash fragment with a
         length limit of 5,000 characters. This is often more useful than the
         referer URL, because many browsers only send the domain for third-party
         requests.
         
        optional string uri = 3;
        Specified by:
        getUriBytes in interface CollectUserEventRequestOrBuilder
        Returns:
        The bytes for uri.
      • hasEts

        public boolean hasEts()
         The event timestamp in milliseconds. This prevents browser caching of
         otherwise identical get requests. The name is abbreviated to reduce the
         payload bytes.
         
        optional int64 ets = 4;
        Specified by:
        hasEts in interface CollectUserEventRequestOrBuilder
        Returns:
        Whether the ets field is set.
      • getEts

        public long getEts()
         The event timestamp in milliseconds. This prevents browser caching of
         otherwise identical get requests. The name is abbreviated to reduce the
         payload bytes.
         
        optional int64 ets = 4;
        Specified by:
        getEts in interface CollectUserEventRequestOrBuilder
        Returns:
        The ets.
      • 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 CollectUserEventRequest parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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