Package com.google.cloud.discoveryengine.v1

Class DocumentInfo

  • All Implemented Interfaces:
    DocumentInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DocumentInfo
extends com.google.protobuf.GeneratedMessageV3
implements DocumentInfoOrBuilder
     Detailed document information associated with a user event.
    Protobuf type google.cloud.discoveryengine.v1.DocumentInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DocumentInfo.Builder
      Detailed document information associated with a user event.
      static class  DocumentInfo.DocumentDescriptorCase  

      • 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 ID_FIELD_NUMBER  
      static int NAME_FIELD_NUMBER  
      static int PROMOTION_IDS_FIELD_NUMBER  
      static int QUANTITY_FIELD_NUMBER  
      static int URI_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static DocumentInfo getDefaultInstance()  
      DocumentInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()  
      String getId()
      The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
      com.google.protobuf.ByteString getIdBytes()
      The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
      String getName()
      The [Document][google.cloud.discoveryengine.v1.Document] resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
      com.google.protobuf.ByteString getNameBytes()
      The [Document][google.cloud.discoveryengine.v1.Document] resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
      com.google.protobuf.Parser<DocumentInfo> getParserForType()  
      String getPromotionIds​(int index)
      The promotion IDs associated with this Document.
      com.google.protobuf.ByteString getPromotionIdsBytes​(int index)
      The promotion IDs associated with this Document.
      int getPromotionIdsCount()
      The promotion IDs associated with this Document.
      com.google.protobuf.ProtocolStringList getPromotionIdsList()
      The promotion IDs associated with this Document.
      int getQuantity()
      Quantity of the Document associated with the user event.
      int getSerializedSize()  
      String getUri()
      The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
      com.google.protobuf.ByteString getUriBytes()
      The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
      int hashCode()  
      boolean hasId()
      The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
      boolean hasName()
      The [Document][google.cloud.discoveryengine.v1.Document] resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
      boolean hasQuantity()
      Quantity of the Document associated with the user event.
      boolean hasUri()
      The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static DocumentInfo.Builder newBuilder()  
      static DocumentInfo.Builder newBuilder​(DocumentInfo prototype)  
      DocumentInfo.Builder newBuilderForType()  
      protected DocumentInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static DocumentInfo parseDelimitedFrom​(InputStream input)  
      static DocumentInfo parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DocumentInfo parseFrom​(byte[] data)  
      static DocumentInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DocumentInfo parseFrom​(com.google.protobuf.ByteString data)  
      static DocumentInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DocumentInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static DocumentInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DocumentInfo parseFrom​(InputStream input)  
      static DocumentInfo parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static DocumentInfo parseFrom​(ByteBuffer data)  
      static DocumentInfo parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<DocumentInfo> parser()  
      DocumentInfo.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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

      • hasId

        public boolean hasId()
         The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
        string id = 1;
        Specified by:
        hasId in interface DocumentInfoOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public String getId()
         The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
        string id = 1;
        Specified by:
        getId in interface DocumentInfoOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
        string id = 1;
        Specified by:
        getIdBytes in interface DocumentInfoOrBuilder
        Returns:
        The bytes for id.

      • hasName

        public boolean hasName()
         The [Document][google.cloud.discoveryengine.v1.Document] resource full
 name, of the form:
 `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
        string name = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasName in interface DocumentInfoOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         The [Document][google.cloud.discoveryengine.v1.Document] resource full
 name, of the form:
 `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
        string name = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface DocumentInfoOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The [Document][google.cloud.discoveryengine.v1.Document] resource full
 name, of the form:
 `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
        string name = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface DocumentInfoOrBuilder
        Returns:
        The bytes for name.

      • hasUri

        public boolean hasUri()
         The [Document][google.cloud.discoveryengine.v1.Document] URI - only
 allowed for website data stores.
        string uri = 6;
        Specified by:
        hasUri in interface DocumentInfoOrBuilder
        Returns:
        Whether the uri field is set.

      • getUri

        public String getUri()
         The [Document][google.cloud.discoveryengine.v1.Document] URI - only
 allowed for website data stores.
        string uri = 6;
        Specified by:
        getUri in interface DocumentInfoOrBuilder
        Returns:
        The uri.

      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         The [Document][google.cloud.discoveryengine.v1.Document] URI - only
 allowed for website data stores.
        string uri = 6;
        Specified by:
        getUriBytes in interface DocumentInfoOrBuilder
        Returns:
        The bytes for uri.

      • hasQuantity

        public boolean hasQuantity()
         Quantity of the Document associated with the user event. Defaults to 1.

 For example, this field will be 2 if two quantities of the same Document
 are involved in a `add-to-cart` event.

 Required for events of the following event types:

 * `add-to-cart`
 * `purchase`
        optional int32 quantity = 3;
        Specified by:
        hasQuantity in interface DocumentInfoOrBuilder
        Returns:
        Whether the quantity field is set.

      • getQuantity

        public int getQuantity()
         Quantity of the Document associated with the user event. Defaults to 1.

 For example, this field will be 2 if two quantities of the same Document
 are involved in a `add-to-cart` event.

 Required for events of the following event types:

 * `add-to-cart`
 * `purchase`
        optional int32 quantity = 3;
        Specified by:
        getQuantity in interface DocumentInfoOrBuilder
        Returns:
        The quantity.

      • getPromotionIdsList

        public com.google.protobuf.ProtocolStringList getPromotionIdsList()
         The promotion IDs associated with this Document.
 Currently, this field is restricted to at most one ID.
        repeated string promotion_ids = 4;
        Specified by:
        getPromotionIdsList in interface DocumentInfoOrBuilder
        Returns:
        A list containing the promotionIds.

      • getPromotionIdsCount

        public int getPromotionIdsCount()
         The promotion IDs associated with this Document.
 Currently, this field is restricted to at most one ID.
        repeated string promotion_ids = 4;
        Specified by:
        getPromotionIdsCount in interface DocumentInfoOrBuilder
        Returns:
        The count of promotionIds.

      • getPromotionIds

        public String getPromotionIds​(int index)
         The promotion IDs associated with this Document.
 Currently, this field is restricted to at most one ID.
        repeated string promotion_ids = 4;
        Specified by:
        getPromotionIds in interface DocumentInfoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The promotionIds at the given index.

      • getPromotionIdsBytes

        public com.google.protobuf.ByteString getPromotionIdsBytes​(int index)
         The promotion IDs associated with this Document.
 Currently, this field is restricted to at most one ID.
        repeated string promotion_ids = 4;
        Specified by:
        getPromotionIdsBytes in interface DocumentInfoOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the promotionIds at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static DocumentInfo getDefaultInstance()

      • parser

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

      • getParserForType

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