# 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"
            tenantId:
                type: tenant_id
                description: "Tenant ID associated with parameter to be set"
                optional: true
            clusterParameterTime:
                type: timestamp
                description: "Timestamp determined at the beginning that determines the parameter time."
                optional: true
            previousTime:
                type: logicalTime
                description: >-
                    "Expected current cluster parameter time for this parameter before the
                    'setClusterParameter' invocation. If this current time does not match the
                    'previousTime' persisted in the 'config.clusterParameters' collection then
                    'setClusterParameter' will fail unless the 'parameter' value matches the current
                    cluster parameter value."
                optional: true
