Package com.vonage.client.video

Class ListStreamCompositionsRequest

java.lang.Object

com.vonage.client.video.ListStreamCompositionsRequest

All Implemented Interfaces:

QueryParamsRequest

public class ListStreamCompositionsRequest
extends Object
implements QueryParamsRequest

Filter properties and pagination for VideoClient.listArchives(ListStreamCompositionsRequest) and VideoClient.listBroadcasts(ListStreamCompositionsRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListStreamCompositionsRequest.Builder

Constructor Summary

Constructors

Constructor	Description
ListStreamCompositionsRequest(ListStreamCompositionsRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ListStreamCompositionsRequest.Builder	builder()	Instantiates a Builder, used to construct this object.
Integer	getCount()	The number of compositions to retrieve starting at offset.
Integer	getOffset()	The start offset in the list of existing compositions.
String	getSessionId()	Retrieve only compositions for a given session ID.
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListStreamCompositionsRequest

public ListStreamCompositionsRequest(ListStreamCompositionsRequest.Builder builder)

Method Details

makeParams

public Map<String,String> makeParams()

Description copied from interface: QueryParamsRequest

Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.

Specified by:

makeParams in interface QueryParamsRequest

Returns:

The query parameters as unique key-value pairs.

getOffset

public Integer getOffset()

The start offset in the list of existing compositions.

Returns:

The results offset index.

getCount

public Integer getCount()

The number of compositions to retrieve starting at offset.

Returns:

The maximum number of results.

getSessionId

public String getSessionId()

Retrieve only compositions for a given session ID.

Returns:

The session ID to filter by.

builder

public static ListStreamCompositionsRequest.Builder builder()

Instantiates a Builder, used to construct this object.

Returns:

A new ListStreamCompositionsRequest.Builder.