Class DaiSession.CreationContext (0.58.0)

public static final class DaiSession.CreationContext extends GeneratedMessage implements DaiSession.CreationContextOrBuilder

Context data to create the DAI session.

Protobuf type google.ads.admanager.v1.DaiSession.CreationContext

Static Fields

CONTENT_TITLE_FIELD_NUMBER

public static final int CONTENT_TITLE_FIELD_NUMBER
Field Value
Type Description
int

DEBUG_KEY_FIELD_NUMBER

public static final int DEBUG_KEY_FIELD_NUMBER
Field Value
Type Description
int

INTERSTITIAL_ENABLED_FIELD_NUMBER

public static final int INTERSTITIAL_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

LINEAR_INFO_FIELD_NUMBER

public static final int LINEAR_INFO_FIELD_NUMBER
Field Value
Type Description
int

REPORTING_TYPE_FIELD_NUMBER

public static final int REPORTING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SESSION_TITLE_FIELD_NUMBER

public static final int SESSION_TITLE_FIELD_NUMBER
Field Value
Type Description
int

STITCHING_TYPE_FIELD_NUMBER

public static final int STITCHING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STREAM_CREATE_REQUEST_FIELD_NUMBER

public static final int STREAM_CREATE_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

VOD_INFO_FIELD_NUMBER

public static final int VOD_INFO_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DaiSession.CreationContext getDefaultInstance()
Returns
Type Description
DaiSession.CreationContext

getDescriptor()

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

newBuilder()

public static DaiSession.CreationContext.Builder newBuilder()
Returns
Type Description
DaiSession.CreationContext.Builder

newBuilder(DaiSession.CreationContext prototype)

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

parseDelimitedFrom(InputStream input)

public static DaiSession.CreationContext parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession.CreationContext
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static DaiSession.CreationContext parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DaiSession.CreationContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static DaiSession.CreationContext parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DaiSession.CreationContext
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static DaiSession.CreationContext parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DaiSession.CreationContext
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static DaiSession.CreationContext parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DaiSession.CreationContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DaiSession.CreationContext> parser()
Returns
Type Description
Parser<CreationContext>

Methods

equals(Object obj)

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

getContentInfoCase()

public DaiSession.CreationContext.ContentInfoCase getContentInfoCase()
Returns
Type Description
DaiSession.CreationContext.ContentInfoCase

getContentTitle()

public String getContentTitle()

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.

optional string content_title = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The contentTitle.

getContentTitleBytes()

public ByteString getContentTitleBytes()

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.

optional string content_title = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for contentTitle.

getDebugKey()

public String getDebugKey()

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.

optional string debug_key = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The debugKey.

getDebugKeyBytes()

public ByteString getDebugKeyBytes()

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.

optional string debug_key = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for debugKey.

getDefaultInstanceForType()

public DaiSession.CreationContext getDefaultInstanceForType()
Returns
Type Description
DaiSession.CreationContext

getInterstitialEnabled()

public boolean getInterstitialEnabled()

Output only. Whether the parameter dai-istl on the stream request is set to true. This parameter is only accepted for LiveStream resources with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.

optional bool interstitial_enabled = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The interstitialEnabled.

getLinearInfo()

public DaiSession.CreationContext.LinearInfo getLinearInfo()

Output only. The LiveStream resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.LinearInfo linear_info = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.CreationContext.LinearInfo

The linearInfo.

getLinearInfoOrBuilder()

public DaiSession.CreationContext.LinearInfoOrBuilder getLinearInfoOrBuilder()

Output only. The LiveStream resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.LinearInfo linear_info = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.CreationContext.LinearInfoOrBuilder

getParserForType()

public Parser<DaiSession.CreationContext> getParserForType()
Returns
Type Description
Parser<CreationContext>
Overrides

getReportingType()

public ReportingTypeEnum.ReportingType getReportingType()

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).

optional .google.ads.admanager.v1.ReportingTypeEnum.ReportingType reporting_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReportingTypeEnum.ReportingType

The reportingType.

getReportingTypeValue()

public int getReportingTypeValue()

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).

optional .google.ads.admanager.v1.ReportingTypeEnum.ReportingType reporting_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for reportingType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionTitle()

public String getSessionTitle()

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.

optional string session_title = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The sessionTitle.

getSessionTitleBytes()

public ByteString getSessionTitleBytes()

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.

optional string session_title = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for sessionTitle.

getStitchingType()

public StitchingTypeEnum.StitchingType getStitchingType()

Output only. Whether the stream request is for Full-service DAI or Pod serving.

optional .google.ads.admanager.v1.StitchingTypeEnum.StitchingType stitching_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StitchingTypeEnum.StitchingType

The stitchingType.

getStitchingTypeValue()

public int getStitchingTypeValue()

Output only. Whether the stream request is for Full-service DAI or Pod serving.

optional .google.ads.admanager.v1.StitchingTypeEnum.StitchingType stitching_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for stitchingType.

getStreamCreateRequest()

public DaiSession.HttpRequest getStreamCreateRequest()

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.

.google.ads.admanager.v1.DaiSession.HttpRequest stream_create_request = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.HttpRequest

The streamCreateRequest.

getStreamCreateRequestOrBuilder()

public DaiSession.HttpRequestOrBuilder getStreamCreateRequestOrBuilder()

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.

.google.ads.admanager.v1.DaiSession.HttpRequest stream_create_request = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.HttpRequestOrBuilder

getVodInfo()

public DaiSession.CreationContext.VodInfo getVodInfo()

Output only. The Content resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.VodInfo vod_info = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.CreationContext.VodInfo

The vodInfo.

getVodInfoOrBuilder()

public DaiSession.CreationContext.VodInfoOrBuilder getVodInfoOrBuilder()

Output only. The Content resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.VodInfo vod_info = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DaiSession.CreationContext.VodInfoOrBuilder

hasContentTitle()

public boolean hasContentTitle()

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.

optional string content_title = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the contentTitle field is set.

hasDebugKey()

public boolean hasDebugKey()

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.

optional string debug_key = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the debugKey field is set.

hasInterstitialEnabled()

public boolean hasInterstitialEnabled()

Output only. Whether the parameter dai-istl on the stream request is set to true. This parameter is only accepted for LiveStream resources with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.

optional bool interstitial_enabled = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the interstitialEnabled field is set.

hasLinearInfo()

public boolean hasLinearInfo()

Output only. The LiveStream resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.LinearInfo linear_info = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the linearInfo field is set.

hasReportingType()

public boolean hasReportingType()

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).

optional .google.ads.admanager.v1.ReportingTypeEnum.ReportingType reporting_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the reportingType field is set.

hasSessionTitle()

public boolean hasSessionTitle()

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.

optional string session_title = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the sessionTitle field is set.

hasStitchingType()

public boolean hasStitchingType()

Output only. Whether the stream request is for Full-service DAI or Pod serving.

optional .google.ads.admanager.v1.StitchingTypeEnum.StitchingType stitching_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the stitchingType field is set.

hasStreamCreateRequest()

public boolean hasStreamCreateRequest()

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.

.google.ads.admanager.v1.DaiSession.HttpRequest stream_create_request = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the streamCreateRequest field is set.

hasVodInfo()

public boolean hasVodInfo()

Output only. The Content resource in the stream request that creates the DAI session.

.google.ads.admanager.v1.DaiSession.CreationContext.VodInfo vod_info = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the vodInfo 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 DaiSession.CreationContext.Builder newBuilderForType()
Returns
Type Description
DaiSession.CreationContext.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

public DaiSession.CreationContext.Builder toBuilder()
Returns
Type Description
DaiSession.CreationContext.Builder

writeTo(CodedOutputStream output)

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