Class DaiEncodingProfile (0.58.0)

public final class DaiEncodingProfile extends GeneratedMessage 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 Fields

AUDIO_SETTINGS_FIELD_NUMBER

public static final int AUDIO_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

CONTAINER_TYPE_FIELD_NUMBER

public static final int CONTAINER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

VARIANT_TYPE_FIELD_NUMBER

public static final int VARIANT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

VIDEO_SETTINGS_FIELD_NUMBER

public static final int VIDEO_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DaiEncodingProfile getDefaultInstance()
Returns
Type Description
DaiEncodingProfile

getDescriptor()

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

newBuilder()

public static DaiEncodingProfile.Builder newBuilder()
Returns
Type Description
DaiEncodingProfile.Builder

newBuilder(DaiEncodingProfile prototype)

public static DaiEncodingProfile.Builder newBuilder(DaiEncodingProfile prototype)
Parameter
Name Description
prototype DaiEncodingProfile
Returns
Type Description
DaiEncodingProfile.Builder

parseDelimitedFrom(InputStream input)

public static DaiEncodingProfile parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DaiEncodingProfile parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DaiEncodingProfile parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DaiEncodingProfile parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DaiEncodingProfile parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DaiEncodingProfile parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DaiEncodingProfile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DaiEncodingProfile
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DaiEncodingProfile> parser()
Returns
Type Description
Parser<DaiEncodingProfile>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

getParserForType()

public Parser<DaiEncodingProfile> getParserForType()
Returns
Type Description
Parser<DaiEncodingProfile>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DaiEncodingProfile.Builder newBuilderForType()
Returns
Type Description
DaiEncodingProfile.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DaiEncodingProfile.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DaiEncodingProfile.Builder
Overrides

toBuilder()

public DaiEncodingProfile.Builder toBuilder()
Returns
Type Description
DaiEncodingProfile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException