Interface DaiEncodingProfileOrBuilder (0.58.0)

public interface DaiEncodingProfileOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudioSettings()

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

getAudioSettingsOrBuilder()

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

getDisplayName()

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

getVideoSettingsOrBuilder()

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