LiveStreamEvent (DFP AppEngine components 3.14.2 API)

java.lang.Object
- com.google.api.ads.dfp.jaxws.v201708.LiveStreamEvent

public class LiveStreamEvent
extends Object

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.

Java class for LiveStreamEvent complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="LiveStreamEvent">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="status" type="{https://www.google.com/apis/ads/publisher/v201708}LiveStreamEventStatus" minOccurs="0"/>
         <element name="creationDateTime" type="{https://www.google.com/apis/ads/publisher/v201708}DateTime" minOccurs="0"/>
         <element name="lastModifiedDateTime" type="{https://www.google.com/apis/ads/publisher/v201708}DateTime" minOccurs="0"/>
         <element name="startDateTime" type="{https://www.google.com/apis/ads/publisher/v201708}DateTime" minOccurs="0"/>
         <element name="endDateTime" type="{https://www.google.com/apis/ads/publisher/v201708}DateTime" minOccurs="0"/>
         <element name="totalEstimatedConcurrentUsers" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="contentUrls" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="adTags" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="liveStreamEventCode" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="authenticationService" type="{https://www.google.com/apis/ads/publisher/v201708}AuthenticationService" minOccurs="0"/>
         <element name="authenticationKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="tokenAuthenticationUnsigned" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="originForwardingType" type="{https://www.google.com/apis/ads/publisher/v201708}OriginForwardingType" minOccurs="0"/>
         <element name="originPathPrefix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="dvrWindowSeconds" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="adBreakFillType" type="{https://www.google.com/apis/ads/publisher/v201708}AdBreakFillType" minOccurs="0"/>
         <element name="adHolidayDuration" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="enableDurationlessAdBreaks" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="defaultAdBreakDuration" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdBreakFillType`	`adBreakFillType`
`protected Long`	`adHolidayDuration`
`protected List<String>`	`adTags`
`protected String`	`authenticationKey`
`protected AuthenticationService`	`authenticationService`
`protected List<String>`	`contentUrls`
`protected DateTime`	`creationDateTime`
`protected Long`	`defaultAdBreakDuration`
`protected String`	`description`
`protected Integer`	`dvrWindowSeconds`
`protected Boolean`	`enableDurationlessAdBreaks`
`protected DateTime`	`endDateTime`
`protected Long`	`id`
`protected DateTime`	`lastModifiedDateTime`
`protected String`	`liveStreamEventCode`
`protected String`	`name`
`protected OriginForwardingType`	`originForwardingType`
`protected String`	`originPathPrefix`
`protected DateTime`	`startDateTime`
`protected LiveStreamEventStatus`	`status`
`protected Boolean`	`tokenAuthenticationUnsigned`
`protected Long`	`totalEstimatedConcurrentUsers`

Constructor Summary

Constructors
Constructor and Description

LiveStreamEvent()

Constructors
Constructor and Description
`LiveStreamEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdBreakFillType`	`getAdBreakFillType()` Gets the value of the adBreakFillType property.
`Long`	`getAdHolidayDuration()` Gets the value of the adHolidayDuration property.
`List<String>`	`getAdTags()` Gets the value of the adTags property.
`String`	`getAuthenticationKey()` Gets the value of the authenticationKey property.
`AuthenticationService`	`getAuthenticationService()` Gets the value of the authenticationService property.
`List<String>`	`getContentUrls()` Gets the value of the contentUrls property.
`DateTime`	`getCreationDateTime()` Gets the value of the creationDateTime property.
`Long`	`getDefaultAdBreakDuration()` Gets the value of the defaultAdBreakDuration property.
`String`	`getDescription()` Gets the value of the description property.
`Integer`	`getDvrWindowSeconds()` Gets the value of the dvrWindowSeconds property.
`DateTime`	`getEndDateTime()` Gets the value of the endDateTime property.
`Long`	`getId()` Gets the value of the id property.
`DateTime`	`getLastModifiedDateTime()` Gets the value of the lastModifiedDateTime property.
`String`	`getLiveStreamEventCode()` Gets the value of the liveStreamEventCode property.
`String`	`getName()` Gets the value of the name property.
`OriginForwardingType`	`getOriginForwardingType()` Gets the value of the originForwardingType property.
`String`	`getOriginPathPrefix()` Gets the value of the originPathPrefix property.
`DateTime`	`getStartDateTime()` Gets the value of the startDateTime property.
`LiveStreamEventStatus`	`getStatus()` Gets the value of the status property.
`Long`	`getTotalEstimatedConcurrentUsers()` Gets the value of the totalEstimatedConcurrentUsers property.
`Boolean`	`isEnableDurationlessAdBreaks()` Gets the value of the enableDurationlessAdBreaks property.
`Boolean`	`isTokenAuthenticationUnsigned()` Gets the value of the tokenAuthenticationUnsigned property.
`void`	`setAdBreakFillType(AdBreakFillType value)` Sets the value of the adBreakFillType property.
`void`	`setAdHolidayDuration(Long value)` Sets the value of the adHolidayDuration property.
`void`	`setAuthenticationKey(String value)` Sets the value of the authenticationKey property.
`void`	`setAuthenticationService(AuthenticationService value)` Sets the value of the authenticationService property.
`void`	`setCreationDateTime(DateTime value)` Sets the value of the creationDateTime property.
`void`	`setDefaultAdBreakDuration(Long value)` Sets the value of the defaultAdBreakDuration property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDvrWindowSeconds(Integer value)` Sets the value of the dvrWindowSeconds property.
`void`	`setEnableDurationlessAdBreaks(Boolean value)` Sets the value of the enableDurationlessAdBreaks property.
`void`	`setEndDateTime(DateTime value)` Sets the value of the endDateTime property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setLastModifiedDateTime(DateTime value)` Sets the value of the lastModifiedDateTime property.
`void`	`setLiveStreamEventCode(String value)` Sets the value of the liveStreamEventCode property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOriginForwardingType(OriginForwardingType value)` Sets the value of the originForwardingType property.
`void`	`setOriginPathPrefix(String value)` Sets the value of the originPathPrefix property.
`void`	`setStartDateTime(DateTime value)` Sets the value of the startDateTime property.
`void`	`setStatus(LiveStreamEventStatus value)` Sets the value of the status property.
`void`	`setTokenAuthenticationUnsigned(Boolean value)` Sets the value of the tokenAuthenticationUnsigned property.
`void`	`setTotalEstimatedConcurrentUsers(Long value)` Sets the value of the totalEstimatedConcurrentUsers property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected Long id
```
  - name
```
protected String name
```
  - description
```
protected String description
```
  - status
```
protected LiveStreamEventStatus status
```
  - creationDateTime
```
protected DateTime creationDateTime
```
  - lastModifiedDateTime
```
protected DateTime lastModifiedDateTime
```
  - startDateTime
```
protected DateTime startDateTime
```
  - endDateTime
```
protected DateTime endDateTime
```
  - totalEstimatedConcurrentUsers
```
protected Long totalEstimatedConcurrentUsers
```
  - contentUrls
```
protected List<String> contentUrls
```
  - adTags
```
protected List<String> adTags
```
  - liveStreamEventCode
```
protected String liveStreamEventCode
```
  - authenticationService
```
protected AuthenticationService authenticationService
```
  - authenticationKey
```
protected String authenticationKey
```
  - tokenAuthenticationUnsigned
```
protected Boolean tokenAuthenticationUnsigned
```
  - originForwardingType
```
protected OriginForwardingType originForwardingType
```
  - originPathPrefix
```
protected String originPathPrefix
```
  - dvrWindowSeconds
```
protected Integer dvrWindowSeconds
```
  - adBreakFillType
```
protected AdBreakFillType adBreakFillType
```
  - adHolidayDuration
```
protected Long adHolidayDuration
```
  - enableDurationlessAdBreaks
```
protected Boolean enableDurationlessAdBreaks
```
  - defaultAdBreakDuration
```
protected Long defaultAdBreakDuration
```
- Constructor Detail
  - LiveStreamEvent
```
public LiveStreamEvent()
```
- Method Detail
  - getId
```
public Long getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Long
  - setId
```
public void setId(Long value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Long
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public LiveStreamEventStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is LiveStreamEventStatus
  - setStatus
```
public void setStatus(LiveStreamEventStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is LiveStreamEventStatus
  - getCreationDateTime
```
public DateTime getCreationDateTime()
```
    Gets the value of the creationDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setCreationDateTime
```
public void setCreationDateTime(DateTime value)
```
    Sets the value of the creationDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getLastModifiedDateTime
```
public DateTime getLastModifiedDateTime()
```
    Gets the value of the lastModifiedDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setLastModifiedDateTime
```
public void setLastModifiedDateTime(DateTime value)
```
    Sets the value of the lastModifiedDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getStartDateTime
```
public DateTime getStartDateTime()
```
    Gets the value of the startDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setStartDateTime
```
public void setStartDateTime(DateTime value)
```
    Sets the value of the startDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getEndDateTime
```
public DateTime getEndDateTime()
```
    Gets the value of the endDateTime property.
    
    Returns:
    
    possible object is DateTime
  - setEndDateTime
```
public void setEndDateTime(DateTime value)
```
    Sets the value of the endDateTime property.
    
    Parameters:
    
    value - allowed object is DateTime
  - getTotalEstimatedConcurrentUsers
```
public Long getTotalEstimatedConcurrentUsers()
```
    Gets the value of the totalEstimatedConcurrentUsers property.
    
    Returns:
    
    possible object is Long
  - setTotalEstimatedConcurrentUsers
```
public void setTotalEstimatedConcurrentUsers(Long value)
```
    Sets the value of the totalEstimatedConcurrentUsers property.
    
    Parameters:
    
    value - allowed object is Long
  - getContentUrls
```
public List<String> getContentUrls()
```
    Gets the value of the contentUrls property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the contentUrls property.
    For example, to add a new item, do as follows:
```
    getContentUrls().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getAdTags
```
public List<String> getAdTags()
```
    Gets the value of the adTags property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the adTags property.
    For example, to add a new item, do as follows:
```
    getAdTags().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getLiveStreamEventCode
```
public String getLiveStreamEventCode()
```
    Gets the value of the liveStreamEventCode property.
    
    Returns:
    
    possible object is String
  - setLiveStreamEventCode
```
public void setLiveStreamEventCode(String value)
```
    Sets the value of the liveStreamEventCode property.
    
    Parameters:
    
    value - allowed object is String
  - getAuthenticationService
```
public AuthenticationService getAuthenticationService()
```
    Gets the value of the authenticationService property.
    
    Returns:
    
    possible object is AuthenticationService
  - setAuthenticationService
```
public void setAuthenticationService(AuthenticationService value)
```
    Sets the value of the authenticationService property.
    
    Parameters:
    
    value - allowed object is AuthenticationService
  - getAuthenticationKey
```
public String getAuthenticationKey()
```
    Gets the value of the authenticationKey property.
    
    Returns:
    
    possible object is String
  - setAuthenticationKey
```
public void setAuthenticationKey(String value)
```
    Sets the value of the authenticationKey property.
    
    Parameters:
    
    value - allowed object is String
  - isTokenAuthenticationUnsigned
```
public Boolean isTokenAuthenticationUnsigned()
```
    Gets the value of the tokenAuthenticationUnsigned property.
    
    Returns:
    
    possible object is Boolean
  - setTokenAuthenticationUnsigned
```
public void setTokenAuthenticationUnsigned(Boolean value)
```
    Sets the value of the tokenAuthenticationUnsigned property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOriginForwardingType
```
public OriginForwardingType getOriginForwardingType()
```
    Gets the value of the originForwardingType property.
    
    Returns:
    
    possible object is OriginForwardingType
  - setOriginForwardingType
```
public void setOriginForwardingType(OriginForwardingType value)
```
    Sets the value of the originForwardingType property.
    
    Parameters:
    
    value - allowed object is OriginForwardingType
  - getOriginPathPrefix
```
public String getOriginPathPrefix()
```
    Gets the value of the originPathPrefix property.
    
    Returns:
    
    possible object is String
  - setOriginPathPrefix
```
public void setOriginPathPrefix(String value)
```
    Sets the value of the originPathPrefix property.
    
    Parameters:
    
    value - allowed object is String
  - getDvrWindowSeconds
```
public Integer getDvrWindowSeconds()
```
    Gets the value of the dvrWindowSeconds property.
    
    Returns:
    
    possible object is Integer
  - setDvrWindowSeconds
```
public void setDvrWindowSeconds(Integer value)
```
    Sets the value of the dvrWindowSeconds property.
    
    Parameters:
    
    value - allowed object is Integer
  - getAdBreakFillType
```
public AdBreakFillType getAdBreakFillType()
```
    Gets the value of the adBreakFillType property.
    
    Returns:
    
    possible object is AdBreakFillType
  - setAdBreakFillType
```
public void setAdBreakFillType(AdBreakFillType value)
```
    Sets the value of the adBreakFillType property.
    
    Parameters:
    
    value - allowed object is AdBreakFillType
  - getAdHolidayDuration
```
public Long getAdHolidayDuration()
```
    Gets the value of the adHolidayDuration property.
    
    Returns:
    
    possible object is Long
  - setAdHolidayDuration
```
public void setAdHolidayDuration(Long value)
```
    Sets the value of the adHolidayDuration property.
    
    Parameters:
    
    value - allowed object is Long
  - isEnableDurationlessAdBreaks
```
public Boolean isEnableDurationlessAdBreaks()
```
    Gets the value of the enableDurationlessAdBreaks property.
    
    Returns:
    
    possible object is Boolean
  - setEnableDurationlessAdBreaks
```
public void setEnableDurationlessAdBreaks(Boolean value)
```
    Sets the value of the enableDurationlessAdBreaks property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getDefaultAdBreakDuration
```
public Long getDefaultAdBreakDuration()
```
    Gets the value of the defaultAdBreakDuration property.
    
    Returns:
    
    possible object is Long
  - setDefaultAdBreakDuration
```
public void setDefaultAdBreakDuration(Long value)
```
    Sets the value of the defaultAdBreakDuration property.
    
    Parameters:
    
    value - allowed object is Long

Class LiveStreamEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

description

status

creationDateTime

lastModifiedDateTime

startDateTime

endDateTime

totalEstimatedConcurrentUsers

contentUrls

adTags

liveStreamEventCode

authenticationService

authenticationKey

tokenAuthenticationUnsigned

originForwardingType

originPathPrefix

dvrWindowSeconds

adBreakFillType

adHolidayDuration

enableDurationlessAdBreaks

defaultAdBreakDuration

Constructor Detail

LiveStreamEvent

Method Detail

getId

setId

getName

setName

getDescription

setDescription

getStatus

setStatus

getCreationDateTime

setCreationDateTime

getLastModifiedDateTime

setLastModifiedDateTime

getStartDateTime

setStartDateTime

getEndDateTime

setEndDateTime

getTotalEstimatedConcurrentUsers

setTotalEstimatedConcurrentUsers

getContentUrls

getAdTags

getLiveStreamEventCode

setLiveStreamEventCode

getAuthenticationService

setAuthenticationService

getAuthenticationKey

setAuthenticationKey

isTokenAuthenticationUnsigned

setTokenAuthenticationUnsigned

getOriginForwardingType

setOriginForwardingType

getOriginPathPrefix

setOriginPathPrefix

getDvrWindowSeconds

setDvrWindowSeconds

getAdBreakFillType

setAdBreakFillType

getAdHolidayDuration

setAdHolidayDuration

isEnableDurationlessAdBreaks

setEnableDurationlessAdBreaks

getDefaultAdBreakDuration

setDefaultAdBreakDuration