Class LiveStream.Builder (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 static final class LiveStream.Builder extends GeneratedMessage.Builder<LiveStream.Builder> 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

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > LiveStream.Builder

Implements

LiveStreamOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAdBreakMarkups(AdBreakMarkupTypeEnum.AdBreakMarkupType value)

public LiveStream.Builder addAdBreakMarkups(AdBreakMarkupTypeEnum.AdBreakMarkupType value)

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
value	AdBreakMarkupTypeEnum.AdBreakMarkupType The adBreakMarkups to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAdBreakMarkupsValue(int value)

public LiveStream.Builder addAdBreakMarkupsValue(int value)

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
value	int The enum numeric value on the wire for adBreakMarkups to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAdTags(String value)

public LiveStream.Builder addAdTags(String value)

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
value	String The adTags to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAdTagsBytes(ByteString value)

public LiveStream.Builder addAdTagsBytes(ByteString value)

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
value	ByteString The bytes of the adTags to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAllAdBreakMarkups(Iterable<? extends AdBreakMarkupTypeEnum.AdBreakMarkupType> values)

public LiveStream.Builder addAllAdBreakMarkups(Iterable<? extends AdBreakMarkupTypeEnum.AdBreakMarkupType> values)

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
values	Iterable<? extends com.google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType> The adBreakMarkups to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAllAdBreakMarkupsValue(Iterable<Integer> values)

public LiveStream.Builder addAllAdBreakMarkupsValue(Iterable<Integer> values)

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
values	Iterable<Integer> The enum numeric values on the wire for adBreakMarkups to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAllAdTags(Iterable<String> values)

public LiveStream.Builder addAllAdTags(Iterable<String> values)

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
values	Iterable<String> The adTags to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAllContentUrls(Iterable<String> values)

public LiveStream.Builder addAllContentUrls(Iterable<String> values)

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
values	Iterable<String> The contentUrls to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addAllSourceContentConfigurations(Iterable<String> values)

public LiveStream.Builder addAllSourceContentConfigurations(Iterable<String> values)

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
values	Iterable<String> The sourceContentConfigurations to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addContentUrls(String value)

public LiveStream.Builder addContentUrls(String value)

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
value	String The contentUrls to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addContentUrlsBytes(ByteString value)

public LiveStream.Builder addContentUrlsBytes(ByteString value)

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
value	ByteString The bytes of the contentUrls to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addSourceContentConfigurations(String value)

public LiveStream.Builder addSourceContentConfigurations(String value)

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
value	String The sourceContentConfigurations to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

addSourceContentConfigurationsBytes(ByteString value)

public LiveStream.Builder addSourceContentConfigurationsBytes(ByteString value)

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
value	ByteString The bytes of the sourceContentConfigurations to add.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

build()

public LiveStream build()

Returns
Type	Description
LiveStream

buildPartial()

public LiveStream buildPartial()

Returns
Type	Description
LiveStream

clear()

public LiveStream.Builder clear()

Returns
Type	Description
LiveStream.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAdBreakFillType()

public LiveStream.Builder clearAdBreakFillType()

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
LiveStream.Builder	This builder for chaining.

clearAdBreakMarkupTypesEnabled()

public LiveStream.Builder clearAdBreakMarkupTypesEnabled()

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
LiveStream.Builder	This builder for chaining.

clearAdBreakMarkups()

public LiveStream.Builder clearAdBreakMarkups()

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
LiveStream.Builder	This builder for chaining.

clearAdHolidayDuration()

public LiveStream.Builder clearAdHolidayDuration()

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
LiveStream.Builder

clearAdMediaDeliveryConfig()

public LiveStream.Builder clearAdMediaDeliveryConfig()

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
LiveStream.Builder	This builder for chaining.

clearAdPodTrimTolerance()

public LiveStream.Builder clearAdPodTrimTolerance()

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
LiveStream.Builder

clearAdTags()

public LiveStream.Builder clearAdTags()

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
LiveStream.Builder	This builder for chaining.

clearAllowlistedIpsEnabled()

public LiveStream.Builder clearAllowlistedIpsEnabled()

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
LiveStream.Builder	This builder for chaining.

clearAssetKey()

public LiveStream.Builder clearAssetKey()

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
LiveStream.Builder	This builder for chaining.

clearAuxiliaryAdSettings()

public LiveStream.Builder clearAuxiliaryAdSettings()

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
LiveStream.Builder

clearContentUrls()

public LiveStream.Builder clearContentUrls()

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
LiveStream.Builder	This builder for chaining.

clearCreateTime()

public LiveStream.Builder clearCreateTime()

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
LiveStream.Builder

clearCustomAssetKey()

public LiveStream.Builder clearCustomAssetKey()

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
LiveStream.Builder	This builder for chaining.

clearDefaultAdBreakDuration()

public LiveStream.Builder clearDefaultAdBreakDuration()

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
LiveStream.Builder

clearDisplayName()

public LiveStream.Builder clearDisplayName()

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
LiveStream.Builder	This builder for chaining.

clearDynamicAdInsertionType()

public LiveStream.Builder clearDynamicAdInsertionType()

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
LiveStream.Builder	This builder for chaining.

clearEarlyBreakNotificationMultiBreakSchedulingEnabled()

public LiveStream.Builder clearEarlyBreakNotificationMultiBreakSchedulingEnabled()

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
LiveStream.Builder	This builder for chaining.

clearEffectiveAssetKey()

public LiveStream.Builder clearEffectiveAssetKey()

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
LiveStream.Builder	This builder for chaining.

clearEnableDaiAuthenticationKeys()

public LiveStream.Builder clearEnableDaiAuthenticationKeys()

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
LiveStream.Builder	This builder for chaining.

clearEnableDurationlessAdBreaks()

public LiveStream.Builder clearEnableDurationlessAdBreaks()

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
LiveStream.Builder	This builder for chaining.

clearEnableMaxFillerDuration()

public LiveStream.Builder clearEnableMaxFillerDuration()

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
LiveStream.Builder	This builder for chaining.

clearEndTime()

public LiveStream.Builder clearEndTime()

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
LiveStream.Builder

clearEndTimeUnlimited()

public LiveStream.Builder clearEndTimeUnlimited()

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
LiveStream.Builder	This builder for chaining.

clearForcedCueInEnabled()

public LiveStream.Builder clearForcedCueInEnabled()

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
LiveStream.Builder	This builder for chaining.

clearHlsSettings()

public LiveStream.Builder clearHlsSettings()

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
LiveStream.Builder

clearLiveStreamConditioning()

public LiveStream.Builder clearLiveStreamConditioning()

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
LiveStream.Builder

clearMaxFillerDuration()

public LiveStream.Builder clearMaxFillerDuration()

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
LiveStream.Builder

clearName()

public LiveStream.Builder clearName()

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
LiveStream.Builder	This builder for chaining.

clearPodServingSegmentDuration()

public LiveStream.Builder clearPodServingSegmentDuration()

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
LiveStream.Builder

clearPrefetchEnabled()

public LiveStream.Builder clearPrefetchEnabled()

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

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

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

clearPrefetchSettings()

public LiveStream.Builder clearPrefetchSettings()

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
LiveStream.Builder

clearPrerollSettings()

public LiveStream.Builder clearPrerollSettings()

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
LiveStream.Builder

clearRelativePlaylistDeliveryEnabled()

public LiveStream.Builder clearRelativePlaylistDeliveryEnabled()

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
LiveStream.Builder	This builder for chaining.

clearShortSegmentDroppingEnabled()

public LiveStream.Builder clearShortSegmentDroppingEnabled()

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
LiveStream.Builder	This builder for chaining.

clearSourceContentConfigurations()

public LiveStream.Builder clearSourceContentConfigurations()

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
LiveStream.Builder	This builder for chaining.

clearStartTime()

public LiveStream.Builder clearStartTime()

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
LiveStream.Builder

clearStatus()

public LiveStream.Builder clearStatus()

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
LiveStream.Builder	This builder for chaining.

clearStreamingFormat()

public LiveStream.Builder clearStreamingFormat()

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
LiveStream.Builder	This builder for chaining.

clearUnderfillAdBreakFillType()

public LiveStream.Builder clearUnderfillAdBreakFillType()

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
LiveStream.Builder	This builder for chaining.

clearUpdateTime()

public LiveStream.Builder clearUpdateTime()

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
LiveStream.Builder

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.

getAdHolidayDurationBuilder()

public Duration.Builder getAdHolidayDurationBuilder()

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
Builder

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.

getAdPodTrimToleranceBuilder()

public Duration.Builder getAdPodTrimToleranceBuilder()

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
Builder

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.

getAuxiliaryAdSettingsBuilder()

public AuxiliaryAdSettings.Builder getAuxiliaryAdSettingsBuilder()

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.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDefaultAdBreakDurationBuilder()

public Duration.Builder getDefaultAdBreakDurationBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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.

getHlsSettingsBuilder()

public HlsSettings.Builder getHlsSettingsBuilder()

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.Builder

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.

getLiveStreamConditioningBuilder()

public LiveStreamConditioning.Builder getLiveStreamConditioningBuilder()

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.Builder

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.

getMaxFillerDurationBuilder()

public Duration.Builder getMaxFillerDurationBuilder()

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
Builder

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.

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.

getPodServingSegmentDurationBuilder()

public Duration.Builder getPodServingSegmentDurationBuilder()

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
Builder

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.

getPrefetchSettingsBuilder()

public PrefetchSettings.Builder getPrefetchSettingsBuilder()

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.Builder

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.

getPrerollSettingsBuilder()

public PrerollSettings.Builder getPrerollSettingsBuilder()

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.Builder

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

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
Builder

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeAdHolidayDuration(Duration value)

public LiveStream.Builder mergeAdHolidayDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

mergeAdPodTrimTolerance(Duration value)

public LiveStream.Builder mergeAdPodTrimTolerance(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

mergeAuxiliaryAdSettings(AuxiliaryAdSettings value)

public LiveStream.Builder mergeAuxiliaryAdSettings(AuxiliaryAdSettings value)

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

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

Parameter
Name	Description
value	AuxiliaryAdSettings

Returns
Type	Description
LiveStream.Builder

mergeCreateTime(Timestamp value)

public LiveStream.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

mergeDefaultAdBreakDuration(Duration value)

public LiveStream.Builder mergeDefaultAdBreakDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

mergeEndTime(Timestamp value)

public LiveStream.Builder mergeEndTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

mergeFrom(LiveStream other)

public LiveStream.Builder mergeFrom(LiveStream other)

Parameter
Name	Description
other	LiveStream

Returns
Type	Description
LiveStream.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LiveStream.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LiveStream.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public LiveStream.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
LiveStream.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeHlsSettings(HlsSettings value)

public LiveStream.Builder mergeHlsSettings(HlsSettings value)

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];

Parameter
Name	Description
value	HlsSettings

Returns
Type	Description
LiveStream.Builder

mergeLiveStreamConditioning(LiveStreamConditioning value)

public LiveStream.Builder mergeLiveStreamConditioning(LiveStreamConditioning value)

Optional. The conditioning to apply to this LiveStream.

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

Parameter
Name	Description
value	LiveStreamConditioning

Returns
Type	Description
LiveStream.Builder

mergeMaxFillerDuration(Duration value)

public LiveStream.Builder mergeMaxFillerDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

mergePodServingSegmentDuration(Duration value)

public LiveStream.Builder mergePodServingSegmentDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

mergePrefetchSettings(PrefetchSettings value)

public LiveStream.Builder mergePrefetchSettings(PrefetchSettings value)

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];

Parameter
Name	Description
value	PrefetchSettings

Returns
Type	Description
LiveStream.Builder

mergePrerollSettings(PrerollSettings value)

public LiveStream.Builder mergePrerollSettings(PrerollSettings value)

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];

Parameter
Name	Description
value	PrerollSettings

Returns
Type	Description
LiveStream.Builder

mergeStartTime(Timestamp value)

public LiveStream.Builder mergeStartTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

mergeUpdateTime(Timestamp value)

public LiveStream.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

setAdBreakFillType(AdBreakFillTypeEnum.AdBreakFillType value)

public LiveStream.Builder setAdBreakFillType(AdBreakFillTypeEnum.AdBreakFillType value)

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];

Parameter
Name	Description
value	AdBreakFillTypeEnum.AdBreakFillType The adBreakFillType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdBreakFillTypeValue(int value)

public LiveStream.Builder setAdBreakFillTypeValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for adBreakFillType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdBreakMarkupTypesEnabled(boolean value)

public LiveStream.Builder setAdBreakMarkupTypesEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The adBreakMarkupTypesEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdBreakMarkups(int index, AdBreakMarkupTypeEnum.AdBreakMarkupType value)

public LiveStream.Builder setAdBreakMarkups(int index, AdBreakMarkupTypeEnum.AdBreakMarkupType value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	AdBreakMarkupTypeEnum.AdBreakMarkupType The adBreakMarkups to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdBreakMarkupsValue(int index, int value)

public LiveStream.Builder setAdBreakMarkupsValue(int index, int value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	int The enum numeric value on the wire for adBreakMarkups to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdHolidayDuration(Duration value)

public LiveStream.Builder setAdHolidayDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

setAdHolidayDuration(Duration.Builder builderForValue)

public LiveStream.Builder setAdHolidayDuration(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setAdMediaDeliveryConfig(String value)

public LiveStream.Builder setAdMediaDeliveryConfig(String value)

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) = { ... }

Parameter
Name	Description
value	String The adMediaDeliveryConfig to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdMediaDeliveryConfigBytes(ByteString value)

public LiveStream.Builder setAdMediaDeliveryConfigBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for adMediaDeliveryConfig to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAdPodTrimTolerance(Duration value)

public LiveStream.Builder setAdPodTrimTolerance(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

setAdPodTrimTolerance(Duration.Builder builderForValue)

public LiveStream.Builder setAdPodTrimTolerance(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setAdTags(int index, String value)

public LiveStream.Builder setAdTags(int index, String value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	String The adTags to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAllowlistedIpsEnabled(boolean value)

public LiveStream.Builder setAllowlistedIpsEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The allowlistedIpsEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAssetKey(String value)

public LiveStream.Builder setAssetKey(String value)

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

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

Parameter
Name	Description
value	String The assetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAssetKeyBytes(ByteString value)

public LiveStream.Builder setAssetKeyBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for assetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setAuxiliaryAdSettings(AuxiliaryAdSettings value)

public LiveStream.Builder setAuxiliaryAdSettings(AuxiliaryAdSettings value)

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

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

Parameter
Name	Description
value	AuxiliaryAdSettings

Returns
Type	Description
LiveStream.Builder

setAuxiliaryAdSettings(AuxiliaryAdSettings.Builder builderForValue)

public LiveStream.Builder setAuxiliaryAdSettings(AuxiliaryAdSettings.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	AuxiliaryAdSettings.Builder

Returns
Type	Description
LiveStream.Builder

setContentUrls(int index, String value)

public LiveStream.Builder setContentUrls(int index, String value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	String The contentUrls to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setCreateTime(Timestamp value)

public LiveStream.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

setCreateTime(Timestamp.Builder builderForValue)

public LiveStream.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setCustomAssetKey(String value)

public LiveStream.Builder setCustomAssetKey(String value)

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];

Parameter
Name	Description
value	String The customAssetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setCustomAssetKeyBytes(ByteString value)

public LiveStream.Builder setCustomAssetKeyBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for customAssetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setDefaultAdBreakDuration(Duration value)

public LiveStream.Builder setDefaultAdBreakDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

setDefaultAdBreakDuration(Duration.Builder builderForValue)

public LiveStream.Builder setDefaultAdBreakDuration(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setDisplayName(String value)

public LiveStream.Builder setDisplayName(String value)

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];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public LiveStream.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setDynamicAdInsertionType(DynamicAdInsertionTypeEnum.DynamicAdInsertionType value)

public LiveStream.Builder setDynamicAdInsertionType(DynamicAdInsertionTypeEnum.DynamicAdInsertionType value)

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];

Parameter
Name	Description
value	DynamicAdInsertionTypeEnum.DynamicAdInsertionType The dynamicAdInsertionType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setDynamicAdInsertionTypeValue(int value)

public LiveStream.Builder setDynamicAdInsertionTypeValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for dynamicAdInsertionType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEarlyBreakNotificationMultiBreakSchedulingEnabled(boolean value)

public LiveStream.Builder setEarlyBreakNotificationMultiBreakSchedulingEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The earlyBreakNotificationMultiBreakSchedulingEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEffectiveAssetKey(String value)

public LiveStream.Builder setEffectiveAssetKey(String value)

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];

Parameter
Name	Description
value	String The effectiveAssetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEffectiveAssetKeyBytes(ByteString value)

public LiveStream.Builder setEffectiveAssetKeyBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for effectiveAssetKey to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEnableDaiAuthenticationKeys(boolean value)

public LiveStream.Builder setEnableDaiAuthenticationKeys(boolean value)

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];

Parameter
Name	Description
value	boolean The enableDaiAuthenticationKeys to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEnableDurationlessAdBreaks(boolean value)

public LiveStream.Builder setEnableDurationlessAdBreaks(boolean value)

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];

Parameter
Name	Description
value	boolean The enableDurationlessAdBreaks to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEnableMaxFillerDuration(boolean value)

public LiveStream.Builder setEnableMaxFillerDuration(boolean value)

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];

Parameter
Name	Description
value	boolean The enableMaxFillerDuration to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setEndTime(Timestamp value)

public LiveStream.Builder setEndTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

setEndTime(Timestamp.Builder builderForValue)

public LiveStream.Builder setEndTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setEndTimeUnlimited(boolean value)

public LiveStream.Builder setEndTimeUnlimited(boolean value)

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];

Parameter
Name	Description
value	boolean The endTimeUnlimited to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setForcedCueInEnabled(boolean value)

public LiveStream.Builder setForcedCueInEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The forcedCueInEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setHlsSettings(HlsSettings value)

public LiveStream.Builder setHlsSettings(HlsSettings value)

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];

Parameter
Name	Description
value	HlsSettings

Returns
Type	Description
LiveStream.Builder

setHlsSettings(HlsSettings.Builder builderForValue)

public LiveStream.Builder setHlsSettings(HlsSettings.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	HlsSettings.Builder

Returns
Type	Description
LiveStream.Builder

setLiveStreamConditioning(LiveStreamConditioning value)

public LiveStream.Builder setLiveStreamConditioning(LiveStreamConditioning value)

Optional. The conditioning to apply to this LiveStream.

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

Parameter
Name	Description
value	LiveStreamConditioning

Returns
Type	Description
LiveStream.Builder

setLiveStreamConditioning(LiveStreamConditioning.Builder builderForValue)

public LiveStream.Builder setLiveStreamConditioning(LiveStreamConditioning.Builder builderForValue)

Optional. The conditioning to apply to this LiveStream.

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

Parameter
Name	Description
builderForValue	LiveStreamConditioning.Builder

Returns
Type	Description
LiveStream.Builder

setMaxFillerDuration(Duration value)

public LiveStream.Builder setMaxFillerDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

setMaxFillerDuration(Duration.Builder builderForValue)

public LiveStream.Builder setMaxFillerDuration(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setName(String value)

public LiveStream.Builder setName(String value)

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

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setNameBytes(ByteString value)

public LiveStream.Builder setNameBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setPodServingSegmentDuration(Duration value)

public LiveStream.Builder setPodServingSegmentDuration(Duration value)

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];

Parameter
Name	Description
value	Duration

Returns
Type	Description
LiveStream.Builder

setPodServingSegmentDuration(Duration.Builder builderForValue)

public LiveStream.Builder setPodServingSegmentDuration(Duration.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setPrefetchEnabled(boolean value)

public LiveStream.Builder setPrefetchEnabled(boolean value)

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

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

Parameter
Name	Description
value	boolean The prefetchEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setPrefetchSettings(PrefetchSettings value)

public LiveStream.Builder setPrefetchSettings(PrefetchSettings value)

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];

Parameter
Name	Description
value	PrefetchSettings

Returns
Type	Description
LiveStream.Builder

setPrefetchSettings(PrefetchSettings.Builder builderForValue)

public LiveStream.Builder setPrefetchSettings(PrefetchSettings.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	PrefetchSettings.Builder

Returns
Type	Description
LiveStream.Builder

setPrerollSettings(PrerollSettings value)

public LiveStream.Builder setPrerollSettings(PrerollSettings value)

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];

Parameter
Name	Description
value	PrerollSettings

Returns
Type	Description
LiveStream.Builder

setPrerollSettings(PrerollSettings.Builder builderForValue)

public LiveStream.Builder setPrerollSettings(PrerollSettings.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	PrerollSettings.Builder

Returns
Type	Description
LiveStream.Builder

setRelativePlaylistDeliveryEnabled(boolean value)

public LiveStream.Builder setRelativePlaylistDeliveryEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The relativePlaylistDeliveryEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setShortSegmentDroppingEnabled(boolean value)

public LiveStream.Builder setShortSegmentDroppingEnabled(boolean value)

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];

Parameter
Name	Description
value	boolean The shortSegmentDroppingEnabled to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setSourceContentConfigurations(int index, String value)

public LiveStream.Builder setSourceContentConfigurations(int index, String value)

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) = { ... }

Parameters
Name	Description
index	int The index to set the value at.
value	String The sourceContentConfigurations to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setStartTime(Timestamp value)

public LiveStream.Builder setStartTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

setStartTime(Timestamp.Builder builderForValue)

public LiveStream.Builder setStartTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder

setStatus(LiveStreamEventStatusEnum.LiveStreamEventStatus value)

public LiveStream.Builder setStatus(LiveStreamEventStatusEnum.LiveStreamEventStatus value)

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];

Parameter
Name	Description
value	LiveStreamEventStatusEnum.LiveStreamEventStatus The status to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setStatusValue(int value)

public LiveStream.Builder setStatusValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for status to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setStreamingFormat(LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat value)

public LiveStream.Builder setStreamingFormat(LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat value)

Immutable. The streaming format of the LiveStream media.

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

Parameter
Name	Description
value	LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat The streamingFormat to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setStreamingFormatValue(int value)

public LiveStream.Builder setStreamingFormatValue(int value)

Immutable. The streaming format of the LiveStream media.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for streamingFormat to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setUnderfillAdBreakFillType(AdBreakFillTypeEnum.AdBreakFillType value)

public LiveStream.Builder setUnderfillAdBreakFillType(AdBreakFillTypeEnum.AdBreakFillType value)

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];

Parameter
Name	Description
value	AdBreakFillTypeEnum.AdBreakFillType The underfillAdBreakFillType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setUnderfillAdBreakFillTypeValue(int value)

public LiveStream.Builder setUnderfillAdBreakFillTypeValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for underfillAdBreakFillType to set.

Returns
Type	Description
LiveStream.Builder	This builder for chaining.

setUpdateTime(Timestamp value)

public LiveStream.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LiveStream.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public LiveStream.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LiveStream.Builder