ORE Studio 0.0.4
Loading...
Searching...
No Matches
list_options.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_CLI_CONFIG_LIST_OPTIONS_HPP
21#define ORES_CLI_CONFIG_LIST_OPTIONS_HPP
22
23#include <iosfwd>
24#include <string>
25#include "ores.cli/config/entity.hpp"
26#include "ores.cli/config/format.hpp"
27
28namespace ores::cli::config {
29
33struct list_options final {
45 std::string as_of;
49 std::string key;
54};
55
56std::ostream& operator<<(std::ostream& s, const list_options& v);
57
58}
59
60#endif
Configuration options related to listing entities.
Definition list_options.hpp:33
std::string as_of
Time point from which to list data. If empty, defaults to latest.
Definition list_options.hpp:45
entity target_entity
Entity to list.
Definition list_options.hpp:37
format target_format
Format for output (json or table).
Definition list_options.hpp:41
bool all_versions
If true, retrieves all versions rather than just latest.
Definition list_options.hpp:53
std::string key
Key to filter data by (optional).
Definition list_options.hpp:49