com.google.api.ads.dfp.axis.v201705

Class LiveStreamEvent

java.lang.Object

com.google.api.ads.dfp.axis.v201705.LiveStreamEvent

All Implemented Interfaces:

Serializable

public class LiveStreamEvent
extends Object
implements Serializable

A LiveStreamEvent encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream.

This includes information such as the start and expected end time of the event, the URL of the actual content for DFP to pull and insert ads into, as well as the metadata necessary to generate ad requests during the event.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LiveStreamEvent()
LiveStreamEvent(Long id, String name, String description, LiveStreamEventStatus status, DateTime creationDateTime, DateTime lastModifiedDateTime, DateTime startDateTime, DateTime endDateTime, Long totalEstimatedConcurrentUsers, String[] contentUrls, String[] adTags, String liveStreamEventCode, AuthenticationService authenticationService, String authenticationKey, Boolean tokenAuthenticationUnsigned, OriginForwardingType originForwardingType, String originPathPrefix, Integer dvrWindowSeconds, AdBreakFillType adBreakFillType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AdBreakFillType	getAdBreakFillType() Gets the adBreakFillType value for this LiveStreamEvent.
String[]	getAdTags() Gets the adTags value for this LiveStreamEvent.
String	getAdTags(int i)
String	getAuthenticationKey() Gets the authenticationKey value for this LiveStreamEvent.
AuthenticationService	getAuthenticationService() Gets the authenticationService value for this LiveStreamEvent.
String[]	getContentUrls() Gets the contentUrls value for this LiveStreamEvent.
String	getContentUrls(int i)
DateTime	getCreationDateTime() Gets the creationDateTime value for this LiveStreamEvent.
String	getDescription() Gets the description value for this LiveStreamEvent.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Integer	getDvrWindowSeconds() Gets the dvrWindowSeconds value for this LiveStreamEvent.
DateTime	getEndDateTime() Gets the endDateTime value for this LiveStreamEvent.
Long	getId() Gets the id value for this LiveStreamEvent.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this LiveStreamEvent.
String	getLiveStreamEventCode() Gets the liveStreamEventCode value for this LiveStreamEvent.
String	getName() Gets the name value for this LiveStreamEvent.
OriginForwardingType	getOriginForwardingType() Gets the originForwardingType value for this LiveStreamEvent.
String	getOriginPathPrefix() Gets the originPathPrefix value for this LiveStreamEvent.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
DateTime	getStartDateTime() Gets the startDateTime value for this LiveStreamEvent.
LiveStreamEventStatus	getStatus() Gets the status value for this LiveStreamEvent.
Boolean	getTokenAuthenticationUnsigned() Gets the tokenAuthenticationUnsigned value for this LiveStreamEvent.
Long	getTotalEstimatedConcurrentUsers() Gets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAdBreakFillType(AdBreakFillType adBreakFillType) Sets the adBreakFillType value for this LiveStreamEvent.
void	setAdTags(int i, String _value)
void	setAdTags(String[] adTags) Sets the adTags value for this LiveStreamEvent.
void	setAuthenticationKey(String authenticationKey) Sets the authenticationKey value for this LiveStreamEvent.
void	setAuthenticationService(AuthenticationService authenticationService) Sets the authenticationService value for this LiveStreamEvent.
void	setContentUrls(int i, String _value)
void	setContentUrls(String[] contentUrls) Sets the contentUrls value for this LiveStreamEvent.
void	setCreationDateTime(DateTime creationDateTime) Sets the creationDateTime value for this LiveStreamEvent.
void	setDescription(String description) Sets the description value for this LiveStreamEvent.
void	setDvrWindowSeconds(Integer dvrWindowSeconds) Sets the dvrWindowSeconds value for this LiveStreamEvent.
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this LiveStreamEvent.
void	setId(Long id) Sets the id value for this LiveStreamEvent.
void	setLastModifiedDateTime(DateTime lastModifiedDateTime) Sets the lastModifiedDateTime value for this LiveStreamEvent.
void	setLiveStreamEventCode(String liveStreamEventCode) Sets the liveStreamEventCode value for this LiveStreamEvent.
void	setName(String name) Sets the name value for this LiveStreamEvent.
void	setOriginForwardingType(OriginForwardingType originForwardingType) Sets the originForwardingType value for this LiveStreamEvent.
void	setOriginPathPrefix(String originPathPrefix) Sets the originPathPrefix value for this LiveStreamEvent.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this LiveStreamEvent.
void	setStatus(LiveStreamEventStatus status) Sets the status value for this LiveStreamEvent.
void	setTokenAuthenticationUnsigned(Boolean tokenAuthenticationUnsigned) Sets the tokenAuthenticationUnsigned value for this LiveStreamEvent.
void	setTotalEstimatedConcurrentUsers(Long totalEstimatedConcurrentUsers) Sets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveStreamEvent

public LiveStreamEvent()

LiveStreamEvent

public LiveStreamEvent(Long id,
                       String name,
                       String description,
                       LiveStreamEventStatus status,
                       DateTime creationDateTime,
                       DateTime lastModifiedDateTime,
                       DateTime startDateTime,
                       DateTime endDateTime,
                       Long totalEstimatedConcurrentUsers,
                       String[] contentUrls,
                       String[] adTags,
                       String liveStreamEventCode,
                       AuthenticationService authenticationService,
                       String authenticationKey,
                       Boolean tokenAuthenticationUnsigned,
                       OriginForwardingType originForwardingType,
                       String originPathPrefix,
                       Integer dvrWindowSeconds,
                       AdBreakFillType adBreakFillType)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getId

public Long getId()

Gets the id value for this LiveStreamEvent.

Returns:

id * The unique ID of the LiveStreamEvent. This value is read-only and is assigned by Google.

setId

public void setId(Long id)

Sets the id value for this LiveStreamEvent.

Parameters:

id - * The unique ID of the LiveStreamEvent. This value is read-only and is assigned by Google.

getName

public String getName()

Gets the name value for this LiveStreamEvent.

Returns:

name * The name of the LiveStreamEvent. This value is required to create a live stream event and has a maximum length of 255 characters.

setName

public void setName(String name)

Sets the name value for this LiveStreamEvent.

Parameters:

name - * The name of the LiveStreamEvent. This value is required to create a live stream event and has a maximum length of 255 characters.

getDescription

public String getDescription()

Gets the description value for this LiveStreamEvent.

Returns:

description * Additional notes to annotate the event with. This attribute is optional and has a maximum length of 65,535 characters.

setDescription

public void setDescription(String description)

Sets the description value for this LiveStreamEvent.

Parameters:

description - * Additional notes to annotate the event with. This attribute is optional and has a maximum length of 65,535 characters.

getStatus

public LiveStreamEventStatus getStatus()

Gets the status value for this LiveStreamEvent.

Returns:

status * The status of this LiveStreamEvent. This attribute is read-only and is assigned by Google. Live stream events are created in the LiveStreamEventStatus.PAUSED state.

setStatus

public void setStatus(LiveStreamEventStatus status)

Sets the status value for this LiveStreamEvent.

Parameters:

status - * The status of this LiveStreamEvent. This attribute is read-only and is assigned by Google. Live stream events are created in the LiveStreamEventStatus.PAUSED state.

getCreationDateTime

public DateTime getCreationDateTime()

Gets the creationDateTime value for this LiveStreamEvent.

Returns:

creationDateTime * The date and time this LiveStreamEvent was created. This attribute is read-only.

setCreationDateTime

public void setCreationDateTime(DateTime creationDateTime)

Sets the creationDateTime value for this LiveStreamEvent.

Parameters:

creationDateTime - * The date and time this LiveStreamEvent was created. This attribute is read-only.

getLastModifiedDateTime

public DateTime getLastModifiedDateTime()

Gets the lastModifiedDateTime value for this LiveStreamEvent.

Returns:

lastModifiedDateTime * The date and time this LiveStreamEvent was last modified. This attribute is read-only.

setLastModifiedDateTime

public void setLastModifiedDateTime(DateTime lastModifiedDateTime)

Sets the lastModifiedDateTime value for this LiveStreamEvent.

Parameters:

lastModifiedDateTime - * The date and time this LiveStreamEvent was last modified. This attribute is read-only.

getStartDateTime

public DateTime getStartDateTime()

Gets the startDateTime value for this LiveStreamEvent.

Returns:

startDateTime * The start date and time of this LiveStreamEvent. This attribute is required if the LiveStreamEvent#startDateTimeType is StartDateTimeType.USE_START_DATE_TIME and is ignored for all other values of StartDateTimeType.

setStartDateTime

public void setStartDateTime(DateTime startDateTime)

Sets the startDateTime value for this LiveStreamEvent.

Parameters:

startDateTime - * The start date and time of this LiveStreamEvent. This attribute is required if the LiveStreamEvent#startDateTimeType is StartDateTimeType.USE_START_DATE_TIME and is ignored for all other values of StartDateTimeType.

getEndDateTime

public DateTime getEndDateTime()

Gets the endDateTime value for this LiveStreamEvent.

Returns:

endDateTime * The scheduled end date and time of this LiveStreamEvent. This attribute is required.

setEndDateTime

public void setEndDateTime(DateTime endDateTime)

Sets the endDateTime value for this LiveStreamEvent.

Parameters:

endDateTime - * The scheduled end date and time of this LiveStreamEvent. This attribute is required.

getTotalEstimatedConcurrentUsers

public Long getTotalEstimatedConcurrentUsers()

Gets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.

Returns:

totalEstimatedConcurrentUsers * The total number of concurrent users expected to watch this event across all regions. This attribute is optional and default value is 0.

setTotalEstimatedConcurrentUsers

public void setTotalEstimatedConcurrentUsers(Long totalEstimatedConcurrentUsers)

Sets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.

Parameters:

totalEstimatedConcurrentUsers - * The total number of concurrent users expected to watch this event across all regions. This attribute is optional and default value is 0.

getContentUrls

public String[] getContentUrls()

Gets the contentUrls value for this LiveStreamEvent.

Returns:

contentUrls * The list of URLs pointing to the live stream content in Content Delivery Network. This attribute is required.

setContentUrls

public void setContentUrls(String[] contentUrls)

Sets the contentUrls value for this LiveStreamEvent.

Parameters:

contentUrls - * The list of URLs pointing to the live stream content in Content Delivery Network. This attribute is required.

getContentUrls

public String getContentUrls(int i)

setContentUrls

public void setContentUrls(int i,
                           String _value)

getAdTags

public String[] getAdTags()

Gets the adTags value for this LiveStreamEvent.

Returns:

adTags * The list of DFP ad tag URLs generated by DFP trafficking workflow that are associated with this live stream event. This attribute is required.

setAdTags

public void setAdTags(String[] adTags)

Sets the adTags value for this LiveStreamEvent.

Parameters:

adTags - * The list of DFP ad tag URLs generated by DFP trafficking workflow that are associated with this live stream event. This attribute is required.

getAdTags

public String getAdTags(int i)

setAdTags

public void setAdTags(int i,
                      String _value)

getLiveStreamEventCode

public String getLiveStreamEventCode()

Gets the liveStreamEventCode value for this LiveStreamEvent.

Returns:

liveStreamEventCode * This code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google.

setLiveStreamEventCode

public void setLiveStreamEventCode(String liveStreamEventCode)

Sets the liveStreamEventCode value for this LiveStreamEvent.

Parameters:

liveStreamEventCode - * This code is used in constructing a live stream event master playlist URL. This attribute is read-only and is assigned by Google.

getAuthenticationService

public AuthenticationService getAuthenticationService()

Gets the authenticationService value for this LiveStreamEvent.

Returns:

authenticationService * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

setAuthenticationService

public void setAuthenticationService(AuthenticationService authenticationService)

Sets the authenticationService value for this LiveStreamEvent.

Parameters:

authenticationService - * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

getAuthenticationKey

public String getAuthenticationKey()

Gets the authenticationKey value for this LiveStreamEvent.

Returns:

authenticationKey * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

setAuthenticationKey

public void setAuthenticationKey(String authenticationKey)

Sets the authenticationKey value for this LiveStreamEvent.

Parameters:

authenticationKey - * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

getTokenAuthenticationUnsigned

public Boolean getTokenAuthenticationUnsigned()

Gets the tokenAuthenticationUnsigned value for this LiveStreamEvent.

Returns:

tokenAuthenticationUnsigned * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

setTokenAuthenticationUnsigned

public void setTokenAuthenticationUnsigned(Boolean tokenAuthenticationUnsigned)

Sets the tokenAuthenticationUnsigned value for this LiveStreamEvent.

Parameters:

tokenAuthenticationUnsigned - * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

getOriginForwardingType

public OriginForwardingType getOriginForwardingType()

Gets the originForwardingType value for this LiveStreamEvent.

Returns:

originForwardingType * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

setOriginForwardingType

public void setOriginForwardingType(OriginForwardingType originForwardingType)

Sets the originForwardingType value for this LiveStreamEvent.

Parameters:

originForwardingType - * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

getOriginPathPrefix

public String getOriginPathPrefix()

Gets the originPathPrefix value for this LiveStreamEvent.

Returns:

originPathPrefix * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

setOriginPathPrefix

public void setOriginPathPrefix(String originPathPrefix)

Sets the originPathPrefix value for this LiveStreamEvent.

Parameters:

originPathPrefix - * This field is deprecated and should not be set or read. Please update the API version to v201711 or later and use the LiveStreamEvent#sourceContentConfigurations field to specify security policies for contentUrls. The value for this field will be out-of-date once LiveStreamEvent#sourceContentConfigurations is used.

getDvrWindowSeconds

public Integer getDvrWindowSeconds()

Gets the dvrWindowSeconds value for this LiveStreamEvent.

Returns:

dvrWindowSeconds * Length of the DVR window in seconds. This value is optional. If unset the default window as provided by the input encoder will be used.

setDvrWindowSeconds

public void setDvrWindowSeconds(Integer dvrWindowSeconds)

Sets the dvrWindowSeconds value for this LiveStreamEvent.

Parameters:

dvrWindowSeconds - * Length of the DVR window in seconds. This value is optional. If unset the default window as provided by the input encoder will be used.

getAdBreakFillType

public AdBreakFillType getAdBreakFillType()

Gets the adBreakFillType value for this LiveStreamEvent.

Returns:

adBreakFillType * The type of content that should be used to fill an empty ad break. This value is optional and defaults to AdBreakFillType.SLATE.

setAdBreakFillType

public void setAdBreakFillType(AdBreakFillType adBreakFillType)

Sets the adBreakFillType value for this LiveStreamEvent.

Parameters:

adBreakFillType - * The type of content that should be used to fill an empty ad break. This value is optional and defaults to AdBreakFillType.SLATE.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer