Files
zeekay 189ce08e51 Regenerate against the document the deployment answers for
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.
2026-09-05 18:07:13 -07:00

141 lines
4.4 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.
*/
/*
* Recording.h
*
*
*/
#ifndef HANZO_MODEL_Recording_H_
#define HANZO_MODEL_Recording_H_
#include <boost/optional.hpp>
#include "hanzo/ModelBase.h"
#include <cpprest/details/basic_types.h>
namespace hanzo {
namespace model {
class Recording
: public ModelBase
{
public:
Recording();
virtual ~Recording();
/////////////////////////////////////////////
/// 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;
/////////////////////////////////////////////
/// Recording members
/// <summary>
/// Bucket is the object store bucket the recording is written to. It is stated beside the key rather than folded into one URI so a client reads two facts instead of splitting a string.
/// </summary>
utility::string_t getBucket() const;
bool bucketIsSet() const;
void unsetBucket();
void setBucket(const utility::string_t& value);
/// <summary>
/// Error is the media server&#39;s reason when a recording failed, and empty otherwise.
/// </summary>
utility::string_t getError() const;
bool errorIsSet() const;
void unsetError();
void setError(const utility::string_t& value);
/// <summary>
/// ID is the media server&#39;s egress id — the handle a later read names.
/// </summary>
utility::string_t getId() const;
bool idIsSet() const;
void unsetId();
void setId(const utility::string_t& value);
/// <summary>
/// Object is the key inside that bucket. Empty only while the media server has not named a file yet. It says WHERE the recording is, not how to fetch it. Reading one back is a separate decision this surface deliberately does not make: a link to a private conversation needs its own answer about who may follow it and for how long, and inventing a short one here would be worse than not having it.
/// </summary>
utility::string_t getObject() const;
bool objectIsSet() const;
void unsetobject();
void setObject(const utility::string_t& value);
/// <summary>
/// Room is the room this recording is of.
/// </summary>
utility::string_t getRoom() const;
bool roomIsSet() const;
void unsetRoom();
void setRoom(const utility::string_t& value);
/// <summary>
/// Started is when the recording began, as the media server reports it: its own &#x60;started_at&#x60;, verbatim and unconverted. LiveKit&#39;s egress service sets that field from UnixNano, and a conversion this side cannot check against the running server would be a number that looks right and is wrong by a factor of a billion. 0 means it has not started.
/// </summary>
int64_t getStarted() const;
bool startedIsSet() const;
void unsetStarted();
void setStarted(int64_t value);
/// <summary>
/// Status is the media server&#39;s own state name: EGRESS_STARTING, EGRESS_ACTIVE, EGRESS_ENDING, EGRESS_COMPLETE, EGRESS_FAILED, EGRESS_ABORTED or EGRESS_LIMIT_REACHED. It is passed through rather than folded into a vocabulary of ours, so the answer cannot mean something the media server did not say.
/// </summary>
utility::string_t getStatus() const;
bool statusIsSet() const;
void unsetStatus();
void setStatus(const utility::string_t& value);
protected:
utility::string_t m_Bucket;
bool m_BucketIsSet;
utility::string_t m_Error;
bool m_ErrorIsSet;
utility::string_t m_Id;
bool m_IdIsSet;
utility::string_t m_object;
bool m_objectIsSet;
utility::string_t m_Room;
bool m_RoomIsSet;
int64_t m_Started;
bool m_StartedIsSet;
utility::string_t m_Status;
bool m_StatusIsSet;
};
}
}
#endif /* HANZO_MODEL_Recording_H_ */