Interface LiveStreamOrBuilder (0.54.0)

public interface LiveStreamOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdBreakFillType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
`List<String>`	A list containing the adTags.

getAllowlistedIpsEnabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
`List<String>`	A list containing the contentUrls.

getCreateTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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`

getDisplayName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getPodServingSegmentDuration()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getShortSegmentDroppingEnabled()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
`List<String>`	A list containing the sourceContentConfigurations.

getStartTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-08-04 UTC.