Package video.api.client.api.models

Class Summary

java.lang.Object

video.api.client.api.models.Summary

All Implemented Interfaces:

Serializable, DeepObject

public class Summary
extends Object
implements Serializable, DeepObject

Summary

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.OriginEnum	Returns the origin of how the summary was created.
static class	Summary.SourceStatusEnum	Returns the current status of summary generation.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_ORIGIN
static String	SERIALIZED_NAME_SOURCE_STATUS
static String	SERIALIZED_NAME_SUMMARY_ID
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_VIDEO_ID

Constructor Summary

Constructors

Constructor	Description
Summary()

Method Summary

Modifier and Type	Method	Description
Summary	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
OffsetDateTime	getCreatedAt()	Returns the date and time when the summary was created in ATOM date-time format.
Summary.OriginEnum	getOrigin()	Returns the origin of how the summary was created.
Summary.SourceStatusEnum	getSourceStatus()	Returns the current status of summary generation.
String	getSummaryId()	The unique identifier of the summary object.
OffsetDateTime	getUpdatedAt()	Returns the date and time when the summary was last updated in ATOM date-time format.
String	getVideoId()	The unique identifier of the video object.
int	hashCode()
Summary	origin(Summary.OriginEnum origin)
void	setCreatedAt(OffsetDateTime createdAt)
void	setOrigin(Summary.OriginEnum origin)
void	setSourceStatus(Summary.SourceStatusEnum sourceStatus)
void	setSummaryId(String summaryId)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setVideoId(String videoId)
Summary	sourceStatus(Summary.SourceStatusEnum sourceStatus)
Summary	summaryId(String summaryId)
String	toString()
Summary	updatedAt(OffsetDateTime updatedAt)
Summary	videoId(String videoId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_SUMMARY_ID

public static final String SERIALIZED_NAME_SUMMARY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_VIDEO_ID

public static final String SERIALIZED_NAME_VIDEO_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGIN

public static final String SERIALIZED_NAME_ORIGIN

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE_STATUS

public static final String SERIALIZED_NAME_SOURCE_STATUS

See Also:

Constant Field Values

Constructor Detail

Summary

public Summary()

Method Detail

summaryId

public Summary summaryId(String summaryId)

getSummaryId

@Nullable
public String getSummaryId()

The unique identifier of the summary object.

Returns:

summaryId

setSummaryId

public void setSummaryId(String summaryId)

createdAt

public Summary createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Returns the date and time when the summary was created in ATOM date-time format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public Summary updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Returns the date and time when the summary was last updated in ATOM date-time format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

videoId

public Summary videoId(String videoId)

getVideoId

@Nullable
public String getVideoId()

The unique identifier of the video object.

Returns:

videoId

setVideoId

public void setVideoId(String videoId)

origin

public Summary origin(Summary.OriginEnum origin)

getOrigin

@Nullable
public Summary.OriginEnum getOrigin()

Returns the origin of how the summary was created. - `api` means that no summary was generated automatically. You can add summary manually using the `PATCH /summaries/{summaryId}/source` endpoint operation. Until this happens, `sourceStatus` returns `missing`. - `auto` means that the API generated the summary automatically.

Returns:

origin

setOrigin

public void setOrigin(Summary.OriginEnum origin)

sourceStatus

public Summary sourceStatus(Summary.SourceStatusEnum sourceStatus)

getSourceStatus

@Nullable
public Summary.SourceStatusEnum getSourceStatus()

Returns the current status of summary generation. `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio.

Returns:

sourceStatus

setSourceStatus

public void setSourceStatus(Summary.SourceStatusEnum sourceStatus)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object