Struct PageContentExportStatusResponse

pub struct PageContentExportStatusResponse {
    pub download_link: Option<String>,
    pub error: Option<String>,
    pub href: String,
    pub id: String,
    pub status: String,
}

Response when requesting the status of a page content export.

JSON schema

{
 "description": "Response when requesting the status of a page content
export.",
 "type": "object",
 "required": [
   "href",
   "id",
   "status"
 ],
 "properties": {
   "downloadLink": {
     "description": "Once the export completes, the location where the
resulting export file can be downloaded; this link typically expires
after a short time.  Call this method again to get a fresh link.",
     "examples": [
       "https://coda.io/blobs/DOC_EXPORT_RENDERING/some-request-id"
     ],
     "type": "string"
   },
   "error": {
     "description": "Message describing an error, if this export
failed.",
     "type": "string"
   },
   "href": {
     "description": "The URL that reports the status of this export.",
     "examples": [
       "https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id"
     ],
     "type": "string"
   },
   "id": {
     "description": "The identifier of this export request.",
     "examples": [
       "AbCDeFGH"
     ],
     "type": "string"
   },
   "status": {
     "description": "The status of this export.",
     "examples": [
       "complete"
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "PageContentExportStatusResponse"
}

Fields

download_link: Option<String>

Once the export completes, the location where the resulting export file can be downloaded; this link typically expires after a short time. Call this method again to get a fresh link.

error: Option<String>

Message describing an error, if this export failed.

href: String

The URL that reports the status of this export.

id: String

The identifier of this export request.

status: String

The status of this export.

Trait Implementations

impl Clone for PageContentExportStatusResponse

fn clone(&self) -> PageContentExportStatusResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageContentExportStatusResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PageContentExportStatusResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PageContentExportStatusResponse> for PageContentExportStatusResponse

fn from(value: &PageContentExportStatusResponse) -> Self

Converts to this type from the input type.

impl Serialize for PageContentExportStatusResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.