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.
295 lines
10 KiB
C++
295 lines
10 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.
|
|
*/
|
|
|
|
/*
|
|
* Wire.h
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifndef HANZO_MODEL_Wire_H_
|
|
#define HANZO_MODEL_Wire_H_
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include "hanzo/ModelBase.h"
|
|
|
|
#include <cpprest/details/basic_types.h>
|
|
|
|
namespace hanzo {
|
|
namespace model {
|
|
|
|
|
|
|
|
class Wire
|
|
: public ModelBase
|
|
{
|
|
public:
|
|
Wire();
|
|
virtual ~Wire();
|
|
|
|
/////////////////////////////////////////////
|
|
/// 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;
|
|
|
|
|
|
/////////////////////////////////////////////
|
|
/// Wire members
|
|
|
|
|
|
/// <summary>
|
|
/// Action is the verb that was performed. It is the event's name, not the HTTP method — a request-sourced record carries both, and the pair is what makes a row readable (\"grant.create\" at POST /v1/admin/grants).
|
|
/// </summary>
|
|
utility::string_t getAction() const;
|
|
bool actionIsSet() const;
|
|
void unsetAction();
|
|
void setAction(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Auth is the credential the actor presented: \"jwt\", \"api-key\", or \"none\".
|
|
/// </summary>
|
|
utility::string_t getAuthMethod() const;
|
|
bool authMethodIsSet() const;
|
|
void unsetAuthMethod();
|
|
void setAuthMethod(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Email is the actor's validated address, absent when the credential carried none. It comes from the verified token, never from a client header.
|
|
/// </summary>
|
|
utility::string_t getEmail() const;
|
|
bool emailIsSet() const;
|
|
void unsetEmail();
|
|
void setEmail(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Hash is this record's SHA-256 over its own canonical JSON with both hash fields cleared, folded with prevHash. Recomputing it from the row's other fields is what proves the row has not been edited.
|
|
/// </summary>
|
|
utility::string_t getHash() const;
|
|
bool hashIsSet() const;
|
|
void unsetHash();
|
|
void setHash(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Home is present ONLY on a cross-org action: the org the actor came FROM, while Org is the org they acted IN. A console row carrying `home` is a platform-admin impersonation and should be rendered as one.
|
|
/// </summary>
|
|
utility::string_t getHome() const;
|
|
bool homeIsSet() const;
|
|
void unsetHome();
|
|
void setHome(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// IsAdmin is the VALIDATED platform-SuperAdmin bit at decision time (membership of the reserved admin org), never the client's own claim to be one.
|
|
/// </summary>
|
|
bool isIsAdmin() const;
|
|
bool isAdminIsSet() const;
|
|
void unsetIsAdmin();
|
|
void setIsAdmin(bool value);
|
|
|
|
/// <summary>
|
|
/// Method is the HTTP verb, on a record a request produced. Absent on an event emitted from inside the binary with no request behind it.
|
|
/// </summary>
|
|
utility::string_t getMethod() const;
|
|
bool methodIsSet() const;
|
|
void unsetMethod();
|
|
void setMethod(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Org is the tenant the action was taken IN — the effective org, which for everyone but an impersonating SuperAdmin is also the actor's own. Empty on an unauthenticated request.
|
|
/// </summary>
|
|
utility::string_t getOrg() const;
|
|
bool orgIsSet() const;
|
|
void unsetOrg();
|
|
void setOrg(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Path is the request's route. Any segment shaped like a credential is replaced before the record is written, so a key that rides in a path is not preserved here by the very control meant to watch it.
|
|
/// </summary>
|
|
utility::string_t getPath() const;
|
|
bool pathIsSet() const;
|
|
void unsetPath();
|
|
void setPath(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// PrevHash is the hash of record seq-1, which is what links the rows into a chain: a deleted or reordered record breaks the recomputation at that point. The first record of a chain carries 64 zeros rather than an empty string, so \"start of chain\" and \"field missing\" cannot look alike.
|
|
/// </summary>
|
|
utility::string_t getPrevHash() const;
|
|
bool prevHashIsSet() const;
|
|
void unsetPrevHash();
|
|
void setPrevHash(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Reason is a short explanation for a deny or an error (\"SuperAdmin required\", \"insufficient_balance\"). It is never a secret and never a raw upstream error body; absent on a success.
|
|
/// </summary>
|
|
utility::string_t getReason() const;
|
|
bool reasonIsSet() const;
|
|
void unsetReason();
|
|
void setReason(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// RequestID ties this row to the request-line log and any downstream trace — the X-Request-Id the pipeline minted for that request.
|
|
/// </summary>
|
|
utility::string_t getRequestId() const;
|
|
bool requestIdIsSet() const;
|
|
void unsetRequestId();
|
|
void setRequestId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Resource is the KIND of thing acted upon (\"org\", \"role\", \"secret\", \"provider-config\", \"credit\"). Where a mutation has no finer semantics than its route, this is the route family and resourceId is empty — the action and the path already pin the object.
|
|
/// </summary>
|
|
utility::string_t getResource() const;
|
|
bool resourceIsSet() const;
|
|
void unsetResource();
|
|
void setResource(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// ResourceID is the specific instance, absent when the kind alone identifies it.
|
|
/// </summary>
|
|
utility::string_t getResourceId() const;
|
|
bool resourceIdIsSet() const;
|
|
void unsetResourceId();
|
|
void setResourceId(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Result is how the action ended: \"success\", \"deny\" or \"error\". A deny is a decision this binary made and is as much evidence as a success.
|
|
/// </summary>
|
|
utility::string_t getResult() const;
|
|
bool resultIsSet() const;
|
|
void unsetResult();
|
|
void setResult(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Seq is the record's position in the chain, 0-based and gapless. The Recorder assigns it under its own lock, so it is a true total order: seq n+1 was written after seq n, and a missing number is a missing record.
|
|
/// </summary>
|
|
int32_t getSeq() const;
|
|
bool seqIsSet() const;
|
|
void unsetSeq();
|
|
void setSeq(int32_t value);
|
|
|
|
/// <summary>
|
|
/// SourceIP is the client address the edge resolved for the request, after the proxy chain — the address a responder would act on, not the socket peer.
|
|
/// </summary>
|
|
utility::string_t getSourceIp() const;
|
|
bool sourceIpIsSet() const;
|
|
void unsetSourceIp();
|
|
void setSourceIp(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Status is the HTTP status the caller received. It is the outcome as the client saw it, so a 200 carrying a domain refusal still reads 200 here.
|
|
/// </summary>
|
|
int64_t getStatus() const;
|
|
bool statusIsSet() const;
|
|
void unsetStatus();
|
|
void setStatus(int64_t value);
|
|
|
|
/// <summary>
|
|
/// Sub is the acting user (the IAM subject). Empty for a machine principal or an anonymous request, which is how a service action is told from a person's.
|
|
/// </summary>
|
|
utility::string_t getSub() const;
|
|
bool subIsSet() const;
|
|
void unsetSub();
|
|
void setSub(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// Time is when the action happened, RFC3339Nano in UTC. The stored column has the same precision and sorts the same way, so a client can range and order on this string verbatim.
|
|
/// </summary>
|
|
utility::string_t getTime() const;
|
|
bool timeIsSet() const;
|
|
void unsetTime();
|
|
void setTime(const utility::string_t& value);
|
|
|
|
/// <summary>
|
|
/// UserAgent is the client the request announced itself as. Client-supplied, so it is evidence about what claimed to act, not proof of it.
|
|
/// </summary>
|
|
utility::string_t getUserAgent() const;
|
|
bool userAgentIsSet() const;
|
|
void unsetUserAgent();
|
|
void setUserAgent(const utility::string_t& value);
|
|
|
|
|
|
protected:
|
|
utility::string_t m_Action;
|
|
bool m_ActionIsSet;
|
|
|
|
utility::string_t m_AuthMethod;
|
|
bool m_AuthMethodIsSet;
|
|
|
|
utility::string_t m_Email;
|
|
bool m_EmailIsSet;
|
|
|
|
utility::string_t m_Hash;
|
|
bool m_HashIsSet;
|
|
|
|
utility::string_t m_Home;
|
|
bool m_HomeIsSet;
|
|
|
|
bool m_IsAdmin;
|
|
bool m_IsAdminIsSet;
|
|
|
|
utility::string_t m_Method;
|
|
bool m_MethodIsSet;
|
|
|
|
utility::string_t m_Org;
|
|
bool m_OrgIsSet;
|
|
|
|
utility::string_t m_Path;
|
|
bool m_PathIsSet;
|
|
|
|
utility::string_t m_PrevHash;
|
|
bool m_PrevHashIsSet;
|
|
|
|
utility::string_t m_Reason;
|
|
bool m_ReasonIsSet;
|
|
|
|
utility::string_t m_RequestId;
|
|
bool m_RequestIdIsSet;
|
|
|
|
utility::string_t m_Resource;
|
|
bool m_ResourceIsSet;
|
|
|
|
utility::string_t m_ResourceId;
|
|
bool m_ResourceIdIsSet;
|
|
|
|
utility::string_t m_Result;
|
|
bool m_ResultIsSet;
|
|
|
|
int32_t m_Seq;
|
|
bool m_SeqIsSet;
|
|
|
|
utility::string_t m_SourceIp;
|
|
bool m_SourceIpIsSet;
|
|
|
|
int64_t m_Status;
|
|
bool m_StatusIsSet;
|
|
|
|
utility::string_t m_Sub;
|
|
bool m_SubIsSet;
|
|
|
|
utility::string_t m_Time;
|
|
bool m_TimeIsSet;
|
|
|
|
utility::string_t m_UserAgent;
|
|
bool m_UserAgentIsSet;
|
|
|
|
};
|
|
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* HANZO_MODEL_Wire_H_ */
|