aboutsummaryrefslogtreecommitdiffstats
path: root/documentapi/src/vespa/documentapi/messagebus/messages/removedocumentmessage.h
blob: 665eb4aa71ab7bf7a440c3b8d948c5cb926fed4b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include "testandsetmessage.h"
#include <vespa/document/base/documentid.h>

namespace documentapi {

class RemoveDocumentMessage : public TestAndSetMessage {
private:
    document::DocumentId _documentId; // The identifier of the document to remove.

protected:
    // Implements DocumentMessage.
    DocumentReply::UP doCreateReply() const override;

public:
    /**
     * Convenience typedef.
     */
    using UP = std::unique_ptr<RemoveDocumentMessage>;
    using SP = std::shared_ptr<RemoveDocumentMessage>;

    /**
     * Constructs a new remove document message with no content.
     */
    RemoveDocumentMessage();

    /**
     * Constructs a new remove document message with a given document id.
     *
     * @param id The identifier of the document to remove.
     */
    RemoveDocumentMessage(const document::DocumentId& id);

    ~RemoveDocumentMessage();

    /**
     * Returns the identifier of the document to remove.
     *
     * @return The document id.
     */
    const document::DocumentId& getDocumentId() const;

    /**
     * Sets the identifier of the document to remove.
     *
     * @param documentId The document id to set.
     */
    void setDocumentId(const document::DocumentId& documentId);

    // Overrides DocumentMessage.
    bool hasSequenceId() const override;

    // Overrides DocumentMessage.
    uint64_t getSequenceId() const override;

    // Implements DocumentMessage.
    uint32_t getType() const override;

    string toString() const override { return "removedocumentmessage"; }
};

}