mirror of
https://github.com/hanzo-cpp/sdk.git
synced 2026-11-20 19:55:32 +00:00
The projection these were generated from was a month old and predated the compute migration, so every one of them described /v1/visor — which the API serves at zero paths now. That is why a hand-written console client and a generated one had drifted the same way at the same time. No /v1/visor path survives here. The word still appears as a source-plane value and inside gvisor and supervisor, which are not this rename.
211 lines
6.6 KiB
C++
211 lines
6.6 KiB
C++
/**
|
|
* Hanzo Cloud API
|
|
* The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
|
|
*
|
|
* The version of the OpenAPI document: v1
|
|
*
|
|
* NOTE: This class is auto generated by OpenAPI-Generator 7.14.0.
|
|
* https://openapi-generator.tech
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
/*
|
|
* RiskDataset.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_RiskDataset_H_
|
|
#define HANZO_MODEL_RiskDataset_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include "hanzo/model/RiskSplitCounts.h"
|
|
#include <cpprest/details/basic_types.h>
|
|
#include "hanzo/model/RiskDatasetSpec.h"
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
class RiskSplitCounts;
|
|
class RiskDatasetSpec;
|
|
|
|
|
|
class RiskDataset
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
RiskDataset();
|
|
virtual ~RiskDataset();
|
|
|
|
/////////////////////////////////////////////
|
|
/// ModelBase overrides
|
|
|
|
void validate() override;
|
|
|
|
web::json::value toJson() const override;
|
|
bool fromJson(const web::json::value& json) override;
|
|
|
|
void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
|
|
bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// RiskDataset members
|
|
|
|
|
|
/// <summary>
|
|
/// At is when this version last changed state, RFC 3339 UTC.
|
|
/// </summary>
|
|
utility::string_t getAt() const;
|
|
bool atIsSet() const;
|
|
void unsetAt();
|
|
void setAt(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// By is who moved it there: the validated user, or the org itself when the caller is a machine with no user behind it.
|
|
/// </summary>
|
|
utility::string_t getBy() const;
|
|
bool byIsSet() const;
|
|
void unsetBy();
|
|
void setBy(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Counts is how the rows fall across the splits.
|
|
/// </summary>
|
|
std::shared_ptr<RiskSplitCounts> getCounts() const;
|
|
bool countsIsSet() const;
|
|
void unsetCounts();
|
|
void setCounts(const std::shared_ptr<RiskSplitCounts>& value);
|
|
|
|
/// <summary>
|
|
/// Digest fingerprints the SPEC and the ROWS together. Two materialisations of one spec agree on it or the plane says they do not.
|
|
/// </summary>
|
|
utility::string_t getDigest() const;
|
|
bool digestIsSet() const;
|
|
void unsetDigest();
|
|
void setDigest(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Name identifies the dataset across all of its versions.
|
|
/// </summary>
|
|
utility::string_t getName() const;
|
|
bool nameIsSet() const;
|
|
void unsetName();
|
|
void setName(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Oversize is how many of the window's subjects this version could NOT carry because their subject identity exceeds the plane's per-subject byte bound. It is on the wire, not only in a log, because it is the one degradation a caller cannot otherwise detect: the rows that are here look complete, and a dataset silently missing a population is a model silently blind to it. Non-zero does not make a version invalid — it makes it a version whose coverage is STATED. Zero is the normal case and omits.
|
|
/// </summary>
|
|
int64_t getOversize() const;
|
|
bool oversizeIsSet() const;
|
|
void unsetOversize();
|
|
void setOversize(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Refusal names why there are no bytes, when there are none.
|
|
/// </summary>
|
|
utility::string_t getRefusal() const;
|
|
bool refusalIsSet() const;
|
|
void unsetRefusal();
|
|
void setRefusal(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Running is true while THIS process is materialising the version. A version that is `materializing` and not running was started by a process that is gone — two states the register cannot tell apart, because a register cannot know which processes are alive.
|
|
/// </summary>
|
|
bool isRunning() const;
|
|
bool runningIsSet() const;
|
|
void unsetRunning();
|
|
void setRunning(bool value);
|
|
|
|
/// <summary>
|
|
/// Share is the fraction of the window's subjects admitted, in thousandths. 1000 means the whole window fitted under the cap; anything less means the version is a reproducible sample and says by how much.
|
|
/// </summary>
|
|
int64_t getShare() const;
|
|
bool shareIsSet() const;
|
|
void unsetShare();
|
|
void setShare(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Spec is the bound query this version was built from, exactly as recorded.
|
|
/// </summary>
|
|
std::shared_ptr<RiskDatasetSpec> getSpec() const;
|
|
bool specIsSet() const;
|
|
void unsetSpec();
|
|
void setSpec(const std::shared_ptr<RiskDatasetSpec>& value);
|
|
|
|
/// <summary>
|
|
/// Status is declared, materializing, ready or refused. Only `ready` has bytes, and `ready` is terminal: a published version is never rewritten.
|
|
/// </summary>
|
|
utility::string_t getStatus() const;
|
|
bool statusIsSet() const;
|
|
void unsetStatus();
|
|
void setStatus(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Truncated is true when the row cap bound before the window ran out. The trailing subject is dropped whole when that happens, because half a subject on one side of a split is exactly the leak the grouping prevents.
|
|
/// </summary>
|
|
bool isTruncated() const;
|
|
bool truncatedIsSet() const;
|
|
void unsetTruncated();
|
|
void setTruncated(bool value);
|
|
|
|
/// <summary>
|
|
/// Version is which version this is, from 1 and monotone within the dataset. A number is never reused — not even after a disposal, where the next declare continues the count — so \"signups v3\" means one thing forever, which is what makes a model's citation of it checkable.
|
|
/// </summary>
|
|
int64_t getVersion() const;
|
|
bool versionIsSet() const;
|
|
void unsetVersion();
|
|
void setVersion(int64_t value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_At;
|
|
bool m_AtIsSet;
|
|
|
|
utility::string_t m_By;
|
|
bool m_ByIsSet;
|
|
|
|
std::shared_ptr<RiskSplitCounts> m_Counts;
|
|
bool m_CountsIsSet;
|
|
|
|
utility::string_t m_Digest;
|
|
bool m_DigestIsSet;
|
|
|
|
utility::string_t m_Name;
|
|
bool m_NameIsSet;
|
|
|
|
int64_t m_Oversize;
|
|
bool m_OversizeIsSet;
|
|
|
|
utility::string_t m_Refusal;
|
|
bool m_RefusalIsSet;
|
|
|
|
bool m_Running;
|
|
bool m_RunningIsSet;
|
|
|
|
int64_t m_Share;
|
|
bool m_ShareIsSet;
|
|
|
|
std::shared_ptr<RiskDatasetSpec> m_Spec;
|
|
bool m_SpecIsSet;
|
|
|
|
utility::string_t m_Status;
|
|
bool m_StatusIsSet;
|
|
|
|
bool m_Truncated;
|
|
bool m_TruncatedIsSet;
|
|
|
|
int64_t m_Version;
|
|
bool m_VersionIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_RiskDataset_H_ */
|