summaryrefslogtreecommitdiff
path: root/src/mongo/db/s/config/set_cluster_parameter_coordinator_document.idl
blob: f8c7d7878bffc61692e7600b6f04d9f312b735d9 (plain)
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
# Copyright (C) 2022-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#


global:
    cpp_namespace: "mongo"

imports:
    - "mongo/db/s/config/configsvr_coordinator.idl"
    - "mongo/db/basic_types.idl"
    - "mongo/s/request_types/sharded_ddl_commands.idl"

enums:
    SetClusterParameterCoordinatorPhase:
        description: "Current set cluster parameter state."
        type: string
        values:
            kUnset: "unset"
            kSetClusterParameter: "setClusterParameter"

structs:
    SetClusterParameterCoordinatorDocument:
        description: "Document to store the POS state"
        generate_comparison_operators: false
        strict: false
        chained_structs:
            ConfigsvrCoordinatorMetadata: ConfigsvrCoordinatorMetadata
        fields:
            phase:
                type: SetClusterParameterCoordinatorPhase
                description: "Coordinator phase."
                default: kUnset
            parameter:
                type: object_owned
                description: "Parameter to be set in the cluster"
            clusterParameterTime:
                type: timestamp
                description: "Timestamp determined at the beginning that determines the parameter time."
                optional: true