com.google.api.ads.admanager.axis.v202002

Class LiveStreamEvent

java.lang.Object

com.google.api.ads.admanager.axis.v202002.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 Ad Manager 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, StartDateTimeType startDateTimeType, DateTime endDateTime, Boolean unlimitedEndDateTime, Long totalEstimatedConcurrentUsers, String[] contentUrls, String[] adTags, String assetKey, Long slateCreativeId, Integer dvrWindowSeconds, Boolean enableDaiAuthenticationKeys, AdBreakFillType adBreakFillType, Long adHolidayDuration, Boolean enableDurationlessAdBreaks, Long defaultAdBreakDuration, long[] daiAuthenticationKeyIds, long[] sourceContentConfigurationIds, HlsSettings hlsSettings, StreamingFormat streamingFormat)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AdBreakFillType	getAdBreakFillType() Gets the adBreakFillType value for this LiveStreamEvent.
Long	getAdHolidayDuration() Gets the adHolidayDuration value for this LiveStreamEvent.
String[]	getAdTags() Gets the adTags value for this LiveStreamEvent.
String	getAdTags(int i)
String	getAssetKey() Gets the assetKey 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.
long[]	getDaiAuthenticationKeyIds() Gets the daiAuthenticationKeyIds value for this LiveStreamEvent.
long	getDaiAuthenticationKeyIds(int i)
Long	getDefaultAdBreakDuration() Gets the defaultAdBreakDuration 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.
Boolean	getEnableDaiAuthenticationKeys() Gets the enableDaiAuthenticationKeys value for this LiveStreamEvent.
Boolean	getEnableDurationlessAdBreaks() Gets the enableDurationlessAdBreaks value for this LiveStreamEvent.
DateTime	getEndDateTime() Gets the endDateTime value for this LiveStreamEvent.
HlsSettings	getHlsSettings() Gets the hlsSettings value for this LiveStreamEvent.
Long	getId() Gets the id value for this LiveStreamEvent.
DateTime	getLastModifiedDateTime() Gets the lastModifiedDateTime value for this LiveStreamEvent.
String	getName() Gets the name value for this LiveStreamEvent.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
Long	getSlateCreativeId() Gets the slateCreativeId value for this LiveStreamEvent.
long[]	getSourceContentConfigurationIds() Gets the sourceContentConfigurationIds value for this LiveStreamEvent.
long	getSourceContentConfigurationIds(int i)
DateTime	getStartDateTime() Gets the startDateTime value for this LiveStreamEvent.
StartDateTimeType	getStartDateTimeType() Gets the startDateTimeType value for this LiveStreamEvent.
LiveStreamEventStatus	getStatus() Gets the status value for this LiveStreamEvent.
StreamingFormat	getStreamingFormat() Gets the streamingFormat value for this LiveStreamEvent.
Long	getTotalEstimatedConcurrentUsers() Gets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
Boolean	getUnlimitedEndDateTime() Gets the unlimitedEndDateTime value for this LiveStreamEvent.
int	hashCode()
void	setAdBreakFillType(AdBreakFillType adBreakFillType) Sets the adBreakFillType value for this LiveStreamEvent.
void	setAdHolidayDuration(Long adHolidayDuration) Sets the adHolidayDuration value for this LiveStreamEvent.
void	setAdTags(int i, String _value)
void	setAdTags(String[] adTags) Sets the adTags value for this LiveStreamEvent.
void	setAssetKey(String assetKey) Sets the assetKey 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	setDaiAuthenticationKeyIds(int i, long _value)
void	setDaiAuthenticationKeyIds(long[] daiAuthenticationKeyIds) Sets the daiAuthenticationKeyIds value for this LiveStreamEvent.
void	setDefaultAdBreakDuration(Long defaultAdBreakDuration) Sets the defaultAdBreakDuration 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	setEnableDaiAuthenticationKeys(Boolean enableDaiAuthenticationKeys) Sets the enableDaiAuthenticationKeys value for this LiveStreamEvent.
void	setEnableDurationlessAdBreaks(Boolean enableDurationlessAdBreaks) Sets the enableDurationlessAdBreaks value for this LiveStreamEvent.
void	setEndDateTime(DateTime endDateTime) Sets the endDateTime value for this LiveStreamEvent.
void	setHlsSettings(HlsSettings hlsSettings) Sets the hlsSettings 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	setName(String name) Sets the name value for this LiveStreamEvent.
void	setSlateCreativeId(Long slateCreativeId) Sets the slateCreativeId value for this LiveStreamEvent.
void	setSourceContentConfigurationIds(int i, long _value)
void	setSourceContentConfigurationIds(long[] sourceContentConfigurationIds) Sets the sourceContentConfigurationIds value for this LiveStreamEvent.
void	setStartDateTime(DateTime startDateTime) Sets the startDateTime value for this LiveStreamEvent.
void	setStartDateTimeType(StartDateTimeType startDateTimeType) Sets the startDateTimeType value for this LiveStreamEvent.
void	setStatus(LiveStreamEventStatus status) Sets the status value for this LiveStreamEvent.
void	setStreamingFormat(StreamingFormat streamingFormat) Sets the streamingFormat value for this LiveStreamEvent.
void	setTotalEstimatedConcurrentUsers(Long totalEstimatedConcurrentUsers) Sets the totalEstimatedConcurrentUsers value for this LiveStreamEvent.
void	setUnlimitedEndDateTime(Boolean unlimitedEndDateTime) Sets the unlimitedEndDateTime 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,
                       StartDateTimeType startDateTimeType,
                       DateTime endDateTime,
                       Boolean unlimitedEndDateTime,
                       Long totalEstimatedConcurrentUsers,
                       String[] contentUrls,
                       String[] adTags,
                       String assetKey,
                       Long slateCreativeId,
                       Integer dvrWindowSeconds,
                       Boolean enableDaiAuthenticationKeys,
                       AdBreakFillType adBreakFillType,
                       Long adHolidayDuration,
                       Boolean enableDurationlessAdBreaks,
                       Long defaultAdBreakDuration,
                       long[] daiAuthenticationKeyIds,
                       long[] sourceContentConfigurationIds,
                       HlsSettings hlsSettings,
                       StreamingFormat streamingFormat)

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 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 startDateTimeType is StartDateTimeType.USE_START_DATE_TIME and is ignored for all other values of StartDateTimeType.

getStartDateTimeType

public StartDateTimeType getStartDateTimeType()

Gets the startDateTimeType value for this LiveStreamEvent.

Returns:

startDateTimeType * Specifies whether to start the LiveStreamEvent right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

setStartDateTimeType

public void setStartDateTimeType(StartDateTimeType startDateTimeType)

Sets the startDateTimeType value for this LiveStreamEvent.

Parameters:

startDateTimeType - * Specifies whether to start the LiveStreamEvent right away, in an hour, etc. This attribute is optional and defaults to StartDateTimeType.USE_START_DATE_TIME.

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 if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true.

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 if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true.

getUnlimitedEndDateTime

public Boolean getUnlimitedEndDateTime()

Gets the unlimitedEndDateTime value for this LiveStreamEvent.

Returns:

unlimitedEndDateTime * Whether the LiveStreamEvent has an end time. This attribute is optional and defaults to false. If this field is true, endDateTime is ignored.

setUnlimitedEndDateTime

public void setUnlimitedEndDateTime(Boolean unlimitedEndDateTime)

Sets the unlimitedEndDateTime value for this LiveStreamEvent.

Parameters:

unlimitedEndDateTime - * Whether the LiveStreamEvent has an end time. This attribute is optional and defaults to false. If this field is true, endDateTime is ignored.

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 Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream event. Currently, the list includes only one element: the master ad tag. This attribute is required.

setAdTags

public void setAdTags(String[] adTags)

Sets the adTags value for this LiveStreamEvent.

Parameters:

adTags - * The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream event. Currently, the list includes only one element: the master ad tag. This attribute is required.

getAdTags

public String getAdTags(int i)

setAdTags

public void setAdTags(int i,
                      String _value)

getAssetKey

public String getAssetKey()

Gets the assetKey value for this LiveStreamEvent.

Returns:

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

setAssetKey

public void setAssetKey(String assetKey)

Sets the assetKey value for this LiveStreamEvent.

Parameters:

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

getSlateCreativeId

public Long getSlateCreativeId()

Gets the slateCreativeId value for this LiveStreamEvent.

Returns:

slateCreativeId * ID corresponding to the slate for this live event. If not set, network default value will be used.

setSlateCreativeId

public void setSlateCreativeId(Long slateCreativeId)

Sets the slateCreativeId value for this LiveStreamEvent.

Parameters:

slateCreativeId - * ID corresponding to the slate for this live event. If not set, network default value will be 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.

getEnableDaiAuthenticationKeys

public Boolean getEnableDaiAuthenticationKeys()

Gets the enableDaiAuthenticationKeys value for this LiveStreamEvent.

Returns:

enableDaiAuthenticationKeys * Whether the event's stream requests to the IMA SDK API will be authenticated using the DAI authentication keys.

setEnableDaiAuthenticationKeys

public void setEnableDaiAuthenticationKeys(Boolean enableDaiAuthenticationKeys)

Sets the enableDaiAuthenticationKeys value for this LiveStreamEvent.

Parameters:

enableDaiAuthenticationKeys - * Whether the event's stream requests to the IMA SDK API will be authenticated using the DAI authentication keys.

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.

getAdHolidayDuration

public Long getAdHolidayDuration()

Gets the adHolidayDuration value for this LiveStreamEvent.

Returns:

adHolidayDuration * The duration (in seconds), starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. This value is optional and defaults to 0.

setAdHolidayDuration

public void setAdHolidayDuration(Long adHolidayDuration)

Sets the adHolidayDuration value for this LiveStreamEvent.

Parameters:

adHolidayDuration - * The duration (in seconds), starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. This value is optional and defaults to 0.

getEnableDurationlessAdBreaks

public Boolean getEnableDurationlessAdBreaks()

Gets the enableDurationlessAdBreaks value for this LiveStreamEvent.

Returns:

enableDurationlessAdBreaks * Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. This field is optional and defaults to false;

setEnableDurationlessAdBreaks

public void setEnableDurationlessAdBreaks(Boolean enableDurationlessAdBreaks)

Sets the enableDurationlessAdBreaks value for this LiveStreamEvent.

Parameters:

enableDurationlessAdBreaks - * Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. This field is optional and defaults to false;

getDefaultAdBreakDuration

public Long getDefaultAdBreakDuration()

Gets the defaultAdBreakDuration value for this LiveStreamEvent.

Returns:

defaultAdBreakDuration * The default ad pod duration (in seconds) that will be requested when an ad break cue-out does not specify a duration. This field is optional and defaults to 0;

setDefaultAdBreakDuration

public void setDefaultAdBreakDuration(Long defaultAdBreakDuration)

Sets the defaultAdBreakDuration value for this LiveStreamEvent.

Parameters:

defaultAdBreakDuration - * The default ad pod duration (in seconds) that will be requested when an ad break cue-out does not specify a duration. This field is optional and defaults to 0;

getDaiAuthenticationKeyIds

public long[] getDaiAuthenticationKeyIds()

Gets the daiAuthenticationKeyIds value for this LiveStreamEvent.

Returns:

daiAuthenticationKeyIds * The list of DaiAuthenticationKey IDs used to authenticate requests for this live stream.

setDaiAuthenticationKeyIds

public void setDaiAuthenticationKeyIds(long[] daiAuthenticationKeyIds)

Sets the daiAuthenticationKeyIds value for this LiveStreamEvent.

Parameters:

daiAuthenticationKeyIds - * The list of DaiAuthenticationKey IDs used to authenticate requests for this live stream.

getDaiAuthenticationKeyIds

public long getDaiAuthenticationKeyIds(int i)

setDaiAuthenticationKeyIds

public void setDaiAuthenticationKeyIds(int i,
                                       long _value)

getSourceContentConfigurationIds

public long[] getSourceContentConfigurationIds()

Gets the sourceContentConfigurationIds value for this LiveStreamEvent.

Returns:

sourceContentConfigurationIds * The list of CdnConfiguration IDs that provide settings for ingesting and delivering the videos associated with this source.

setSourceContentConfigurationIds

public void setSourceContentConfigurationIds(long[] sourceContentConfigurationIds)

Sets the sourceContentConfigurationIds value for this LiveStreamEvent.

Parameters:

sourceContentConfigurationIds - * The list of CdnConfiguration IDs that provide settings for ingesting and delivering the videos associated with this source.

getSourceContentConfigurationIds

public long getSourceContentConfigurationIds(int i)

setSourceContentConfigurationIds

public void setSourceContentConfigurationIds(int i,
                                             long _value)

getHlsSettings

public HlsSettings getHlsSettings()

Gets the hlsSettings value for this LiveStreamEvent.

Returns:

hlsSettings * The settings that are specific to HTTPS live streaming (HLS) protocol. This field is optional and if it is not set will use the default HLS settings.

setHlsSettings

public void setHlsSettings(HlsSettings hlsSettings)

Sets the hlsSettings value for this LiveStreamEvent.

Parameters:

hlsSettings - * The settings that are specific to HTTPS live streaming (HLS) protocol. This field is optional and if it is not set will use the default HLS settings.

getStreamingFormat

public StreamingFormat getStreamingFormat()

Gets the streamingFormat value for this LiveStreamEvent.

Returns:

streamingFormat * The streaming format of the LiveStreamEvent media.

setStreamingFormat

public void setStreamingFormat(StreamingFormat streamingFormat)

Sets the streamingFormat value for this LiveStreamEvent.

Parameters:

streamingFormat - * The streaming format of the LiveStreamEvent media.

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