Class DaiEncodingProfile.Builder (0.58.0)

public static final class DaiEncodingProfile.Builder extends GeneratedMessage.Builder<DaiEncodingProfile.Builder> implements DaiEncodingProfileOrBuilder

A DaiEncodingProfile contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video.

Protobuf type google.ads.admanager.v1.DaiEncodingProfile

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public DaiEncodingProfile build()
Returns
Type Description
DaiEncodingProfile

buildPartial()

public DaiEncodingProfile buildPartial()
Returns
Type Description
DaiEncodingProfile

clear()

public DaiEncodingProfile.Builder clear()
Returns
Type Description
DaiEncodingProfile.Builder
Overrides

clearAudioSettings()

public DaiEncodingProfile.Builder clearAudioSettings()

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DaiEncodingProfile.Builder

clearContainerType()

public DaiEncodingProfile.Builder clearContainerType()

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

clearDisplayName()

public DaiEncodingProfile.Builder clearDisplayName()

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

clearName()

public DaiEncodingProfile.Builder clearName()

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

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

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

clearStatus()

public DaiEncodingProfile.Builder clearStatus()

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

clearVariantType()

public DaiEncodingProfile.Builder clearVariantType()

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

clearVideoSettings()

public DaiEncodingProfile.Builder clearVideoSettings()

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DaiEncodingProfile.Builder

getAudioSettings()

public AudioSettings getAudioSettings()

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioSettings

The audioSettings.

getAudioSettingsBuilder()

public AudioSettings.Builder getAudioSettingsBuilder()

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioSettings.Builder

getAudioSettingsOrBuilder()

public AudioSettingsOrBuilder getAudioSettingsOrBuilder()

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioSettingsOrBuilder

getContainerType()

public ContainerTypeEnum.ContainerType getContainerType()

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ContainerTypeEnum.ContainerType

The containerType.

getContainerTypeValue()

public int getContainerTypeValue()

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for containerType.

getDefaultInstanceForType()

public DaiEncodingProfile getDefaultInstanceForType()
Returns
Type Description
DaiEncodingProfile

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_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 DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

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

Returns
Type Description
ByteString

The bytes for name.

getStatus()

public DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus getStatus()

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus

The status.

getStatusValue()

public int getStatusValue()

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getVariantType()

public DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType getVariantType()

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType

The variantType.

getVariantTypeValue()

public int getVariantTypeValue()

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for variantType.

getVideoSettings()

public VideoSettings getVideoSettings()

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoSettings

The videoSettings.

getVideoSettingsBuilder()

public VideoSettings.Builder getVideoSettingsBuilder()

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoSettings.Builder

getVideoSettingsOrBuilder()

public VideoSettingsOrBuilder getVideoSettingsOrBuilder()

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoSettingsOrBuilder

hasAudioSettings()

public boolean hasAudioSettings()

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the audioSettings field is set.

hasContainerType()

public boolean hasContainerType()

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the containerType field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Returns
Type Description
boolean

Whether the displayName field is set.

hasStatus()

public boolean hasStatus()

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the status field is set.

hasVariantType()

public boolean hasVariantType()

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the variantType field is set.

hasVideoSettings()

public boolean hasVideoSettings()

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the videoSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAudioSettings(AudioSettings value)

public DaiEncodingProfile.Builder mergeAudioSettings(AudioSettings value)

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AudioSettings
Returns
Type Description
DaiEncodingProfile.Builder

mergeFrom(DaiEncodingProfile other)

public DaiEncodingProfile.Builder mergeFrom(DaiEncodingProfile other)
Parameter
Name Description
other DaiEncodingProfile
Returns
Type Description
DaiEncodingProfile.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DaiEncodingProfile.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DaiEncodingProfile.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DaiEncodingProfile.Builder
Overrides

mergeVideoSettings(VideoSettings value)

public DaiEncodingProfile.Builder mergeVideoSettings(VideoSettings value)

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VideoSettings
Returns
Type Description
DaiEncodingProfile.Builder

setAudioSettings(AudioSettings value)

public DaiEncodingProfile.Builder setAudioSettings(AudioSettings value)

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AudioSettings
Returns
Type Description
DaiEncodingProfile.Builder

setAudioSettings(AudioSettings.Builder builderForValue)

public DaiEncodingProfile.Builder setAudioSettings(AudioSettings.Builder builderForValue)

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.

.google.ads.admanager.v1.AudioSettings audio_settings = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AudioSettings.Builder
Returns
Type Description
DaiEncodingProfile.Builder

setContainerType(ContainerTypeEnum.ContainerType value)

public DaiEncodingProfile.Builder setContainerType(ContainerTypeEnum.ContainerType value)

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ContainerTypeEnum.ContainerType

The containerType to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setContainerTypeValue(int value)

public DaiEncodingProfile.Builder setContainerTypeValue(int value)

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

optional .google.ads.admanager.v1.ContainerTypeEnum.ContainerType container_type = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for containerType to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setDisplayName(String value)

public DaiEncodingProfile.Builder setDisplayName(String value)

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DaiEncodingProfile.Builder setDisplayNameBytes(ByteString value)

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setName(String value)

public DaiEncodingProfile.Builder setName(String value)

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DaiEncodingProfile.Builder setNameBytes(ByteString value)

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setStatus(DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus value)

public DaiEncodingProfile.Builder setStatus(DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus value)

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus

The status to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setStatusValue(int value)

public DaiEncodingProfile.Builder setStatusValue(int value)

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.

optional .google.ads.admanager.v1.DaiEncodingProfileStatusEnum.DaiEncodingProfileStatus status = 4 [(.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
DaiEncodingProfile.Builder

This builder for chaining.

setVariantType(DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType value)

public DaiEncodingProfile.Builder setVariantType(DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType value)

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType

The variantType to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setVariantTypeValue(int value)

public DaiEncodingProfile.Builder setVariantTypeValue(int value)

Required. The variant playlist type that this DaiEncodingProfile represents.

optional .google.ads.admanager.v1.DaiEncodingProfileVariantTypeEnum.DaiEncodingProfileVariantType variant_type = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for variantType to set.

Returns
Type Description
DaiEncodingProfile.Builder

This builder for chaining.

setVideoSettings(VideoSettings value)

public DaiEncodingProfile.Builder setVideoSettings(VideoSettings value)

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VideoSettings
Returns
Type Description
DaiEncodingProfile.Builder

setVideoSettings(VideoSettings.Builder builderForValue)

public DaiEncodingProfile.Builder setVideoSettings(VideoSettings.Builder builderForValue)

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.

.google.ads.admanager.v1.VideoSettings video_settings = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue VideoSettings.Builder
Returns
Type Description
DaiEncodingProfile.Builder