Package video.api.client.api.models

Class SummaryCreationPayload

java.lang.Object

video.api.client.api.models.SummaryCreationPayload

All Implemented Interfaces:

Serializable, DeepObject

public class SummaryCreationPayload
extends Object
implements Serializable, DeepObject

SummaryCreationPayload

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummaryCreationPayload.AttributesEnum	Gets or Sets attributes
static class	SummaryCreationPayload.OriginEnum	Use this parameter to define how the API generates the summary.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_ATTRIBUTES
static String	SERIALIZED_NAME_ORIGIN
static String	SERIALIZED_NAME_VIDEO_ID

Constructor Summary

Constructors

Constructor	Description
SummaryCreationPayload()

Method Summary

Modifier and Type	Method	Description
SummaryCreationPayload	addAttributesItem(SummaryCreationPayload.AttributesEnum attributesItem)
SummaryCreationPayload	attributes(List<SummaryCreationPayload.AttributesEnum> attributes)
boolean	equals(Object o)
List<SummaryCreationPayload.AttributesEnum>	getAttributes()	Use this parameter to define the elements of a summary that you want to generate.
SummaryCreationPayload.OriginEnum	getOrigin()	Use this parameter to define how the API generates the summary.
String	getVideoId()	Create a summary of a video using the video ID.
int	hashCode()
SummaryCreationPayload	origin(SummaryCreationPayload.OriginEnum origin)
void	setAttributes(List<SummaryCreationPayload.AttributesEnum> attributes)
void	setOrigin(SummaryCreationPayload.OriginEnum origin)
void	setVideoId(String videoId)
String	toString()
SummaryCreationPayload	videoId(String videoId)

Methods inherited from class java.lang.Object

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

Field Detail

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_ATTRIBUTES

public static final String SERIALIZED_NAME_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

SummaryCreationPayload

public SummaryCreationPayload()

Method Detail

videoId

public SummaryCreationPayload videoId(String videoId)

getVideoId

public String getVideoId()

Create a summary of a video using the video ID.

Returns:

videoId

setVideoId

public void setVideoId(String videoId)

origin

public SummaryCreationPayload origin(SummaryCreationPayload.OriginEnum origin)

getOrigin

@Nullable
public SummaryCreationPayload.OriginEnum getOrigin()

Use this parameter to define how the API generates the summary. The only allowed value is `auto`, which means that the API generates a summary automatically. If you do not set this parameter, **the API will not generate a summary automatically**. In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation.

Returns:

origin

setOrigin

public void setOrigin(SummaryCreationPayload.OriginEnum origin)

attributes

public SummaryCreationPayload attributes(List<SummaryCreationPayload.AttributesEnum> attributes)

addAttributesItem

public SummaryCreationPayload addAttributesItem(SummaryCreationPayload.AttributesEnum attributesItem)

getAttributes

@Nullable
public List<SummaryCreationPayload.AttributesEnum> getAttributes()

Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.

Returns:

attributes

setAttributes

public void setAttributes(List<SummaryCreationPayload.AttributesEnum> attributes)

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