Class LiveStream (0.54.0)

0.54.0 (latest) 0.53.0 0.52.0 0.50.0 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class LiveStream extends GeneratedMessage implements LiveStreamOrBuilder

A LiveStream 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 live stream, 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 live stream.

Protobuf type google.ads.admanager.v1.LiveStream

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LiveStream

Implements

LiveStreamOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AD_BREAK_FILL_TYPE_FIELD_NUMBER

public static final int AD_BREAK_FILL_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

AD_BREAK_MARKUPS_FIELD_NUMBER

public static final int AD_BREAK_MARKUPS_FIELD_NUMBER

Field Value
Type	Description
int

AD_BREAK_MARKUP_TYPES_ENABLED_FIELD_NUMBER

public static final int AD_BREAK_MARKUP_TYPES_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

AD_HOLIDAY_DURATION_FIELD_NUMBER

public static final int AD_HOLIDAY_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

AD_MEDIA_DELIVERY_CONFIG_FIELD_NUMBER

public static final int AD_MEDIA_DELIVERY_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

AD_POD_TRIM_TOLERANCE_FIELD_NUMBER

public static final int AD_POD_TRIM_TOLERANCE_FIELD_NUMBER

Field Value
Type	Description
int

AD_TAGS_FIELD_NUMBER

public static final int AD_TAGS_FIELD_NUMBER

Field Value
Type	Description
int

ALLOWLISTED_IPS_ENABLED_FIELD_NUMBER

public static final int ALLOWLISTED_IPS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

ASSET_KEY_FIELD_NUMBER

public static final int ASSET_KEY_FIELD_NUMBER

Field Value
Type	Description
int

AUXILIARY_AD_SETTINGS_FIELD_NUMBER

public static final int AUXILIARY_AD_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

CONTENT_URLS_FIELD_NUMBER

public static final int CONTENT_URLS_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

CUSTOM_ASSET_KEY_FIELD_NUMBER

public static final int CUSTOM_ASSET_KEY_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_AD_BREAK_DURATION_FIELD_NUMBER

public static final int DEFAULT_AD_BREAK_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

DYNAMIC_AD_INSERTION_TYPE_FIELD_NUMBER

public static final int DYNAMIC_AD_INSERTION_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

EARLY_BREAK_NOTIFICATION_MULTI_BREAK_SCHEDULING_ENABLED_FIELD_NUMBER

public static final int EARLY_BREAK_NOTIFICATION_MULTI_BREAK_SCHEDULING_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

EFFECTIVE_ASSET_KEY_FIELD_NUMBER

public static final int EFFECTIVE_ASSET_KEY_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_DAI_AUTHENTICATION_KEYS_FIELD_NUMBER

public static final int ENABLE_DAI_AUTHENTICATION_KEYS_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_DURATIONLESS_AD_BREAKS_FIELD_NUMBER

public static final int ENABLE_DURATIONLESS_AD_BREAKS_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_MAX_FILLER_DURATION_FIELD_NUMBER

public static final int ENABLE_MAX_FILLER_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
int

END_TIME_UNLIMITED_FIELD_NUMBER

public static final int END_TIME_UNLIMITED_FIELD_NUMBER

Field Value
Type	Description
int

FORCED_CUE_IN_ENABLED_FIELD_NUMBER

public static final int FORCED_CUE_IN_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

HLS_SETTINGS_FIELD_NUMBER

public static final int HLS_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

LIVE_STREAM_CONDITIONING_FIELD_NUMBER

public static final int LIVE_STREAM_CONDITIONING_FIELD_NUMBER

Field Value
Type	Description
int

MAX_FILLER_DURATION_FIELD_NUMBER

public static final int MAX_FILLER_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

POD_SERVING_SEGMENT_DURATION_FIELD_NUMBER

public static final int POD_SERVING_SEGMENT_DURATION_FIELD_NUMBER

Field Value
Type	Description
int

PREFETCH_ENABLED_FIELD_NUMBER

public static final int PREFETCH_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

PREFETCH_SETTINGS_FIELD_NUMBER

public static final int PREFETCH_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

PREROLL_SETTINGS_FIELD_NUMBER

public static final int PREROLL_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
int

RELATIVE_PLAYLIST_DELIVERY_ENABLED_FIELD_NUMBER

public static final int RELATIVE_PLAYLIST_DELIVERY_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

SHORT_SEGMENT_DROPPING_ENABLED_FIELD_NUMBER

public static final int SHORT_SEGMENT_DROPPING_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

SOURCE_CONTENT_CONFIGURATIONS_FIELD_NUMBER

public static final int SOURCE_CONTENT_CONFIGURATIONS_FIELD_NUMBER

Field Value
Type	Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

Field Value
Type	Description
int

STREAMING_FORMAT_FIELD_NUMBER

public static final int STREAMING_FORMAT_FIELD_NUMBER

Field Value
Type	Description
int

UNDERFILL_AD_BREAK_FILL_TYPE_FIELD_NUMBER

public static final int UNDERFILL_AD_BREAK_FILL_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static LiveStream getDefaultInstance()

Returns
Type	Description
LiveStream

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static LiveStream.Builder newBuilder()

Returns
Type	Description
LiveStream.Builder

newBuilder(LiveStream prototype)

public static LiveStream.Builder newBuilder(LiveStream prototype)

Parameter
Name	Description
prototype	LiveStream

Returns
Type	Description
LiveStream.Builder

parseDelimitedFrom(InputStream input)

public static LiveStream parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static LiveStream parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LiveStream parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LiveStream parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static LiveStream parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static LiveStream parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LiveStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<LiveStream> parser()

Returns
Type	Description
Parser<LiveStream>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAdBreakFillType()

public AdBreakFillTypeEnum.AdBreakFillType getAdBreakFillType()

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType ad_break_fill_type = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdBreakFillTypeEnum.AdBreakFillType	The adBreakFillType.

getAdBreakFillTypeValue()

public int getAdBreakFillTypeValue()

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType ad_break_fill_type = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for adBreakFillType.

getAdBreakMarkupTypesEnabled()

public boolean getAdBreakMarkupTypesEnabled()

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.

optional bool ad_break_markup_types_enabled = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The adBreakMarkupTypesEnabled.

getAdBreakMarkups(int index)

public AdBreakMarkupTypeEnum.AdBreakMarkupType getAdBreakMarkups(int index)

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

repeated .google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType ad_break_markups = 42 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
AdBreakMarkupTypeEnum.AdBreakMarkupType	The adBreakMarkups at the given index.

getAdBreakMarkupsCount()

public int getAdBreakMarkupsCount()

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

repeated .google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType ad_break_markups = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of adBreakMarkups.

getAdBreakMarkupsList()

public List<AdBreakMarkupTypeEnum.AdBreakMarkupType> getAdBreakMarkupsList()

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

repeated .google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType ad_break_markups = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<AdBreakMarkupType>	A list containing the adBreakMarkups.

getAdBreakMarkupsValue(int index)

public int getAdBreakMarkupsValue(int index)

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

repeated .google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType ad_break_markups = 42 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of adBreakMarkups at the given index.

getAdBreakMarkupsValueList()

public List<Integer> getAdBreakMarkupsValueList()

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

repeated .google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType ad_break_markups = 42 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for adBreakMarkups.

getAdHolidayDuration()

public Duration getAdHolidayDuration()

Optional. The duration, 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. Defaults to 0.

optional .google.protobuf.Duration ad_holiday_duration = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The adHolidayDuration.

getAdHolidayDurationOrBuilder()

public DurationOrBuilder getAdHolidayDurationOrBuilder()

Optional. The duration, 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. Defaults to 0.

optional .google.protobuf.Duration ad_holiday_duration = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getAdMediaDeliveryConfig()

public String getAdMediaDeliveryConfig()

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

optional string ad_media_delivery_config = 27 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The adMediaDeliveryConfig.

getAdMediaDeliveryConfigBytes()

public ByteString getAdMediaDeliveryConfigBytes()

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

optional string ad_media_delivery_config = 27 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for adMediaDeliveryConfig.

getAdPodTrimTolerance()

public Duration getAdPodTrimTolerance()

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

.google.protobuf.Duration ad_pod_trim_tolerance = 55 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The adPodTrimTolerance.

getAdPodTrimToleranceOrBuilder()

public DurationOrBuilder getAdPodTrimToleranceOrBuilder()

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

.google.protobuf.Duration ad_pod_trim_tolerance = 55 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getAdTags(int index)

public String getAdTags(int index)

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

repeated string ad_tags = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The adTags at the given index.

getAdTagsBytes(int index)

public ByteString getAdTagsBytes(int index)

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

repeated string ad_tags = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the adTags at the given index.

getAdTagsCount()

public int getAdTagsCount()

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

repeated string ad_tags = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of adTags.

getAdTagsList()

public ProtocolStringList getAdTagsList()

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

repeated string ad_tags = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ProtocolStringList	A list containing the adTags.

getAllowlistedIpsEnabled()

public boolean getAllowlistedIpsEnabled()

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic.

optional bool allowlisted_ips_enabled = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The allowlistedIpsEnabled.

getAssetKey()

public String getAssetKey()

Output only. The code used in constructing a live stream master playlist URL.

optional string asset_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The assetKey.

getAssetKeyBytes()

public ByteString getAssetKeyBytes()

Output only. The code used in constructing a live stream master playlist URL.

optional string asset_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for assetKey.

getAuxiliaryAdSettings()

public AuxiliaryAdSettings getAuxiliaryAdSettings()

Optional. The auxiliary ad tag settings for this live stream.

.google.ads.admanager.v1.AuxiliaryAdSettings auxiliary_ad_settings = 57 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuxiliaryAdSettings	The auxiliaryAdSettings.

getAuxiliaryAdSettingsOrBuilder()

public AuxiliaryAdSettingsOrBuilder getAuxiliaryAdSettingsOrBuilder()

Optional. The auxiliary ad tag settings for this live stream.

.google.ads.admanager.v1.AuxiliaryAdSettings auxiliary_ad_settings = 57 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuxiliaryAdSettingsOrBuilder

getContentUrls(int index)

public String getContentUrls(int index)

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

repeated string content_urls = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The contentUrls at the given index.

getContentUrlsBytes(int index)

public ByteString getContentUrlsBytes(int index)

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

repeated string content_urls = 9 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the contentUrls at the given index.

getContentUrlsCount()

public int getContentUrlsCount()

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

repeated string content_urls = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of contentUrls.

getContentUrlsList()

public ProtocolStringList getContentUrlsList()

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

repeated string content_urls = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ProtocolStringList	A list containing the contentUrls.

getCreateTime()

public Timestamp getCreateTime()

Output only. The date and time this LiveStream was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The date and time this LiveStream was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCustomAssetKey()

public String getCustomAssetKey()

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string custom_asset_key = 39 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The customAssetKey.

getCustomAssetKeyBytes()

public ByteString getCustomAssetKeyBytes()

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string custom_asset_key = 39 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for customAssetKey.

getDefaultAdBreakDuration()

public Duration getDefaultAdBreakDuration()

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

optional .google.protobuf.Duration default_ad_break_duration = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The defaultAdBreakDuration.

getDefaultAdBreakDurationOrBuilder()

public DurationOrBuilder getDefaultAdBreakDurationOrBuilder()

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

optional .google.protobuf.Duration default_ad_break_duration = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getDefaultInstanceForType()

public LiveStream getDefaultInstanceForType()

Returns
Type	Description
LiveStream

getDisplayName()

public String getDisplayName()

Required. The name of the LiveStream. This value has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The name of the LiveStream. This value has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getDynamicAdInsertionType()

public DynamicAdInsertionTypeEnum.DynamicAdInsertionType getDynamicAdInsertionType()

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

optional .google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType dynamic_ad_insertion_type = 31 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
DynamicAdInsertionTypeEnum.DynamicAdInsertionType	The dynamicAdInsertionType.

getDynamicAdInsertionTypeValue()

public int getDynamicAdInsertionTypeValue()

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

optional .google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType dynamic_ad_insertion_type = 31 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for dynamicAdInsertionType.

getEarlyBreakNotificationMultiBreakSchedulingEnabled()

public boolean getEarlyBreakNotificationMultiBreakSchedulingEnabled()

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.

optional bool early_break_notification_multi_break_scheduling_enabled = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The earlyBreakNotificationMultiBreakSchedulingEnabled.

getEffectiveAssetKey()

public String getEffectiveAssetKey()

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

optional string effective_asset_key = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The effectiveAssetKey.

getEffectiveAssetKeyBytes()

public ByteString getEffectiveAssetKeyBytes()

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

optional string effective_asset_key = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for effectiveAssetKey.

getEnableDaiAuthenticationKeys()

public boolean getEnableDaiAuthenticationKeys()

Optional. Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.

optional bool enable_dai_authentication_keys = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableDaiAuthenticationKeys.

getEnableDurationlessAdBreaks()

public boolean getEnableDurationlessAdBreaks()

Optional. Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. Defaults to false.

optional bool enable_durationless_ad_breaks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableDurationlessAdBreaks.

getEnableMaxFillerDuration()

public boolean getEnableMaxFillerDuration()

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.

optional bool enable_max_filler_duration = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableMaxFillerDuration.

getEndTime()

public Timestamp getEndTime()

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getEndTimeUnlimited()

public boolean getEndTimeUnlimited()

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.

optional bool end_time_unlimited = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The endTimeUnlimited.

getForcedCueInEnabled()

public boolean getForcedCueInEnabled()

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.

optional bool forced_cue_in_enabled = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The forcedCueInEnabled.

getHlsSettings()

public HlsSettings getHlsSettings()

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

.google.ads.admanager.v1.HlsSettings hls_settings = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HlsSettings	The hlsSettings.

getHlsSettingsOrBuilder()

public HlsSettingsOrBuilder getHlsSettingsOrBuilder()

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

.google.ads.admanager.v1.HlsSettings hls_settings = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
HlsSettingsOrBuilder

getLiveStreamConditioning()

public LiveStreamConditioning getLiveStreamConditioning()

Optional. The conditioning to apply to this LiveStream.

.google.ads.admanager.v1.LiveStreamConditioning live_stream_conditioning = 46 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LiveStreamConditioning	The liveStreamConditioning.

getLiveStreamConditioningOrBuilder()

public LiveStreamConditioningOrBuilder getLiveStreamConditioningOrBuilder()

Optional. The conditioning to apply to this LiveStream.

.google.ads.admanager.v1.LiveStreamConditioning live_stream_conditioning = 46 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LiveStreamConditioningOrBuilder

getMaxFillerDuration()

public Duration getMaxFillerDuration()

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

optional .google.protobuf.Duration max_filler_duration = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The maxFillerDuration.

getMaxFillerDurationOrBuilder()

public DurationOrBuilder getMaxFillerDurationOrBuilder()

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

optional .google.protobuf.Duration max_filler_duration = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getName()

public String getName()

Identifier. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<LiveStream> getParserForType()

Returns
Type	Description
Parser<LiveStream>

Overrides

GeneratedMessage.getParserForType()

getPodServingSegmentDuration()

public Duration getPodServingSegmentDuration()

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

optional .google.protobuf.Duration pod_serving_segment_duration = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Duration	The podServingSegmentDuration.

getPodServingSegmentDurationOrBuilder()

public DurationOrBuilder getPodServingSegmentDurationOrBuilder()

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

optional .google.protobuf.Duration pod_serving_segment_duration = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DurationOrBuilder

getPrefetchEnabled()

public boolean getPrefetchEnabled()

Optional. Indicates whether the option to prefetch ad requests is enabled.

optional bool prefetch_enabled = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The prefetchEnabled.

getPrefetchSettings()

public PrefetchSettings getPrefetchSettings()

Optional. The information needed to prefetch ad requests for an ad break.

.google.ads.admanager.v1.PrefetchSettings prefetch_settings = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrefetchSettings	The prefetchSettings.

getPrefetchSettingsOrBuilder()

public PrefetchSettingsOrBuilder getPrefetchSettingsOrBuilder()

Optional. The information needed to prefetch ad requests for an ad break.

.google.ads.admanager.v1.PrefetchSettings prefetch_settings = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrefetchSettingsOrBuilder

getPrerollSettings()

public PrerollSettings getPrerollSettings()

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

.google.ads.admanager.v1.PrerollSettings preroll_settings = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrerollSettings	The prerollSettings.

getPrerollSettingsOrBuilder()

public PrerollSettingsOrBuilder getPrerollSettingsOrBuilder()

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

.google.ads.admanager.v1.PrerollSettings preroll_settings = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrerollSettingsOrBuilder

getRelativePlaylistDeliveryEnabled()

public boolean getRelativePlaylistDeliveryEnabled()

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.

optional bool relative_playlist_delivery_enabled = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The relativePlaylistDeliveryEnabled.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getShortSegmentDroppingEnabled()

public boolean getShortSegmentDroppingEnabled()

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.

optional bool short_segment_dropping_enabled = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The shortSegmentDroppingEnabled.

getSourceContentConfigurations(int index)

public String getSourceContentConfigurations(int index)

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

repeated string source_content_configurations = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The sourceContentConfigurations at the given index.

getSourceContentConfigurationsBytes(int index)

public ByteString getSourceContentConfigurationsBytes(int index)

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

repeated string source_content_configurations = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the sourceContentConfigurations at the given index.

getSourceContentConfigurationsCount()

public int getSourceContentConfigurationsCount()

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

repeated string source_content_configurations = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
int	The count of sourceContentConfigurations.

getSourceContentConfigurationsList()

public ProtocolStringList getSourceContentConfigurationsList()

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

repeated string source_content_configurations = 26 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ProtocolStringList	A list containing the sourceContentConfigurations.

getStartTime()

public Timestamp getStartTime()

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getStatus()

public LiveStreamEventStatusEnum.LiveStreamEventStatus getStatus()

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.

optional .google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
LiveStreamEventStatusEnum.LiveStreamEventStatus	The status.

getStatusValue()

public int getStatusValue()

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.

optional .google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for status.

getStreamingFormat()

public LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat getStreamingFormat()

Immutable. The streaming format of the LiveStream media.

optional .google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat streaming_format = 34 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat	The streamingFormat.

getStreamingFormatValue()

public int getStreamingFormatValue()

Immutable. The streaming format of the LiveStream media.

optional .google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat streaming_format = 34 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for streamingFormat.

getUnderfillAdBreakFillType()

public AdBreakFillTypeEnum.AdBreakFillType getUnderfillAdBreakFillType()

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType underfill_ad_break_fill_type = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdBreakFillTypeEnum.AdBreakFillType	The underfillAdBreakFillType.

getUnderfillAdBreakFillTypeValue()

public int getUnderfillAdBreakFillTypeValue()

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType underfill_ad_break_fill_type = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for underfillAdBreakFillType.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The date and time this LiveStream was last modified.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The date and time this LiveStream was last modified.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasAdBreakFillType()

public boolean hasAdBreakFillType()

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType ad_break_fill_type = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adBreakFillType field is set.

hasAdBreakMarkupTypesEnabled()

public boolean hasAdBreakMarkupTypesEnabled()

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.

optional bool ad_break_markup_types_enabled = 43 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adBreakMarkupTypesEnabled field is set.

hasAdHolidayDuration()

public boolean hasAdHolidayDuration()

Optional. The duration, 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. Defaults to 0.

optional .google.protobuf.Duration ad_holiday_duration = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adHolidayDuration field is set.

hasAdMediaDeliveryConfig()

public boolean hasAdMediaDeliveryConfig()

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

optional string ad_media_delivery_config = 27 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the adMediaDeliveryConfig field is set.

hasAdPodTrimTolerance()

public boolean hasAdPodTrimTolerance()

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

.google.protobuf.Duration ad_pod_trim_tolerance = 55 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the adPodTrimTolerance field is set.

hasAllowlistedIpsEnabled()

public boolean hasAllowlistedIpsEnabled()

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic.

optional bool allowlisted_ips_enabled = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the allowlistedIpsEnabled field is set.

hasAssetKey()

public boolean hasAssetKey()

Output only. The code used in constructing a live stream master playlist URL.

optional string asset_key = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the assetKey field is set.

hasAuxiliaryAdSettings()

public boolean hasAuxiliaryAdSettings()

Optional. The auxiliary ad tag settings for this live stream.

.google.ads.admanager.v1.AuxiliaryAdSettings auxiliary_ad_settings = 57 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the auxiliaryAdSettings field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The date and time this LiveStream was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCustomAssetKey()

public boolean hasCustomAssetKey()

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

optional string custom_asset_key = 39 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the customAssetKey field is set.

hasDefaultAdBreakDuration()

public boolean hasDefaultAdBreakDuration()

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

optional .google.protobuf.Duration default_ad_break_duration = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the defaultAdBreakDuration field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The name of the LiveStream. This value has a maximum length of 255 characters.

optional string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the displayName field is set.

hasDynamicAdInsertionType()

public boolean hasDynamicAdInsertionType()

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

optional .google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType dynamic_ad_insertion_type = 31 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the dynamicAdInsertionType field is set.

hasEarlyBreakNotificationMultiBreakSchedulingEnabled()

public boolean hasEarlyBreakNotificationMultiBreakSchedulingEnabled()

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.

optional bool early_break_notification_multi_break_scheduling_enabled = 54 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the earlyBreakNotificationMultiBreakSchedulingEnabled field is set.

hasEffectiveAssetKey()

public boolean hasEffectiveAssetKey()

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

optional string effective_asset_key = 56 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the effectiveAssetKey field is set.

hasEnableDaiAuthenticationKeys()

public boolean hasEnableDaiAuthenticationKeys()

Optional. Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.

optional bool enable_dai_authentication_keys = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the enableDaiAuthenticationKeys field is set.

hasEnableDurationlessAdBreaks()

public boolean hasEnableDurationlessAdBreaks()

Optional. Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. Defaults to false.

optional bool enable_durationless_ad_breaks = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the enableDurationlessAdBreaks field is set.

hasEnableMaxFillerDuration()

public boolean hasEnableMaxFillerDuration()

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.

optional bool enable_max_filler_duration = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the enableMaxFillerDuration field is set.

hasEndTime()

public boolean hasEndTime()

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp end_time = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endTime field is set.

hasEndTimeUnlimited()

public boolean hasEndTimeUnlimited()

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.

optional bool end_time_unlimited = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endTimeUnlimited field is set.

hasForcedCueInEnabled()

public boolean hasForcedCueInEnabled()

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.

optional bool forced_cue_in_enabled = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the forcedCueInEnabled field is set.

hasHlsSettings()

public boolean hasHlsSettings()

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

.google.ads.admanager.v1.HlsSettings hls_settings = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the hlsSettings field is set.

hasLiveStreamConditioning()

public boolean hasLiveStreamConditioning()

Optional. The conditioning to apply to this LiveStream.

.google.ads.admanager.v1.LiveStreamConditioning live_stream_conditioning = 46 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the liveStreamConditioning field is set.

hasMaxFillerDuration()

public boolean hasMaxFillerDuration()

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

optional .google.protobuf.Duration max_filler_duration = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the maxFillerDuration field is set.

hasPodServingSegmentDuration()

public boolean hasPodServingSegmentDuration()

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

optional .google.protobuf.Duration pod_serving_segment_duration = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the podServingSegmentDuration field is set.

hasPrefetchEnabled()

public boolean hasPrefetchEnabled()

Optional. Indicates whether the option to prefetch ad requests is enabled.

optional bool prefetch_enabled = 35 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the prefetchEnabled field is set.

hasPrefetchSettings()

public boolean hasPrefetchSettings()

Optional. The information needed to prefetch ad requests for an ad break.

.google.ads.admanager.v1.PrefetchSettings prefetch_settings = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the prefetchSettings field is set.

hasPrerollSettings()

public boolean hasPrerollSettings()

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

.google.ads.admanager.v1.PrerollSettings preroll_settings = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the prerollSettings field is set.

hasRelativePlaylistDeliveryEnabled()

public boolean hasRelativePlaylistDeliveryEnabled()

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.

optional bool relative_playlist_delivery_enabled = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the relativePlaylistDeliveryEnabled field is set.

hasShortSegmentDroppingEnabled()

public boolean hasShortSegmentDroppingEnabled()

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.

optional bool short_segment_dropping_enabled = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the shortSegmentDroppingEnabled field is set.

hasStartTime()

public boolean hasStartTime()

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the startTime field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.

optional .google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the status field is set.

hasStreamingFormat()

public boolean hasStreamingFormat()

Immutable. The streaming format of the LiveStream media.

optional .google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat streaming_format = 34 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the streamingFormat field is set.

hasUnderfillAdBreakFillType()

public boolean hasUnderfillAdBreakFillType()

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.

optional .google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType underfill_ad_break_fill_type = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the underfillAdBreakFillType field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The date and time this LiveStream was last modified.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public LiveStream.Builder newBuilderForType()

Returns
Type	Description
LiveStream.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LiveStream.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
LiveStream.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public LiveStream.Builder toBuilder()

Returns
Type	Description
LiveStream.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException