Package com.coveo.pushapiclient

Class Document

java.lang.Object
com.coveo.pushapiclient.Document
public class Document extends Object

  • Field Details

    • metadata

      public final HashMap<String,Object> metadata
      The metadata key-value pairs for a given document.

      Each metadata in the document must be unique.

      Metadata are case-insensitive (e.g., the Push API considers mykey, MyKey, myKey, MYKEY, etc. as identical).

      See https://docs.coveo.com/en/115 for more information.

    • permissions

      public DocumentPermissions[] permissions
      The list of permission sets for this item.

      This is useful when item based security is required (i.e., when security isn't configured at the source level).

      See https://docs.coveo.com/en/107 for more information.

    • uri

      public String uri
      The Uniform Resource Identifier (URI) that uniquely identifies the document in a Coveo index.

      Examples: - `http://www.example.com/` - `file://folder/text.txt`

    • documentId

      public String documentId
      The documentId of the document.

    • title

      public String title
      The title of the document.

    • clickableUri

      public String clickableUri
      The clickable URI associated with the document.

    • author

      public String author
      The author of the document.

    • date

      public String date
      The date of the document, represented as an ISO string.

      Optional, will default to indexation date.

    • modifiedDate

      public String modifiedDate
      The modified date of the document, represented as an ISO string.

      Optional, will default to indexation date.

    • permanentId

      public String permanentId
      The permanent identifier of a document that does not change over time.

      Optional, will be derived from the document URI.

    • parentId

      public String parentId
      The unique identifier (URI) of the parent item.

      Specifying a value for this key creates a relationship between the attachment item (child) and its parent item.

      This value also ensures that a parent and all of its attachments will be routed in the same index slice.

    • data

      public String data
      The textual (non-binary) content of the item.

      Whenever you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary), you should use the CompressedBinaryData or CompressedBinaryDataFileId attribute instead, depending on the content size.

      Accepts 5 MB or less of uncompressed textual data.

      See https://docs.coveo.com/en/73 for more information.

      Example: `This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.`

    • compressedBinaryData

      public CompressedBinaryData compressedBinaryData
      The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.

      You can use this parameter when you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is less than 5 MB.

      Whenever you're pushing an item whose size is 5 MB or more, use the CompressedBinaryDataFileId property instead.

      If you're pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.

      See https://docs.coveo.com/en/73 for more information.

    • compressedBinaryDataFileId

      public String compressedBinaryDataFileId
      The fileId from the content that has been uploaded to the S3 via a FileContainer. The file is compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib).

      You can use this parameter when you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is greater than 5 MB.

      Whenever you're pushing an item whose size is less than 5 MB, use the CompressedBinaryData property instead.

      If you're pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.

      See https://docs.coveo.com/en/73 for more information.

    • fileExtension

      public String fileExtension
      The file extension of the data you're pushing.

      This is useful when pushing a compressed item. The converter uses this information to identify how to correctly process the item.

      Values must include the preceding . character.

      Example: `.html`

  • Constructor Details

    • Document

      public Document()