UploadedResource

public final class UploadedResource

Constructors

UploadedResource

UploadedResource UploadedResource(FileTypeEnum fileType, String format, String title, TypeEnum type, String url, LocalDateTime createdAt, String description, Integer filesize, String id, LocalDateTime lastModified, String latest, Metrics metrics, String mime, String previewUrl, LocalDateTime published, Boolean success)

Functions

getCreatedAt

final LocalDateTime getCreatedAt()

getDescription

final String getDescription()

getFilesize

final Integer getFilesize()

getFileType

final FileTypeEnum getFileType()

getFormat

final String getFormat()

getId

final String getId()

getLastModified

final LocalDateTime getLastModified()

getLatest

final String getLatest()

getMetrics

final Metrics getMetrics()

getMime

final String getMime()

getPreviewUrl

final String getPreviewUrl()

getPublished

final LocalDateTime getPublished()

getSuccess

final Boolean getSuccess()

getTitle

final String getTitle()

getType

final TypeEnum getType()

getUrl

final String getUrl()

setCreatedAt

final Unit setCreatedAt(LocalDateTime createdAt)

setDescription

final Unit setDescription(String description)

setFilesize

final Unit setFilesize(Integer filesize)

setFileType

final Unit setFileType(FileTypeEnum fileType)

setFormat

final Unit setFormat(String format)

setId

final Unit setId(String id)

setLastModified

final Unit setLastModified(LocalDateTime lastModified)

setLatest

final Unit setLatest(String latest)

setMetrics

final Unit setMetrics(Metrics metrics)

setMime

final Unit setMime(String mime)

setPreviewUrl

final Unit setPreviewUrl(String previewUrl)

setPublished

final Unit setPublished(LocalDateTime published)

setSuccess

final Unit setSuccess(Boolean success)

setTitle

final Unit setTitle(String title)

setType

final Unit setType(TypeEnum type)

setUrl

final Unit setUrl(String url)

Properties

createdAt

private LocalDateTime createdAt

The resource creation date

description

private String description

The resource markdown description

filesize

private Integer filesize

The resource file size in bytes

fileType

private FileTypeEnum fileType

Whether the resource is an uploaded file, a remote file or an API

format

private String format

The resource format

id

private String id

The resource unique ID

lastModified

private LocalDateTime lastModified

The resource last modification date

latest

private String latest

The permanent URL redirecting to the latest version of the resource. When the resource data is updated, the URL will change, the latest URL won't.

metrics

private Metrics metrics

The resource metrics

mime

private String mime

The resource mime type

previewUrl

private String previewUrl

An optional preview URL to be loaded as a standalone page (ie. iframe or new page)

published

private LocalDateTime published

The resource publication date

success

private Boolean success

Whether the upload succeeded or not.

title

private String title

The resource title

type

private TypeEnum type

Resource type (documentation, API...)

url

private String url

The resource URL