Interface ClientSideBeaconingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>, SdkBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>, SdkPojo

Enclosing class:

ClientSideBeaconingConfiguration

@Mutable
@NotThreadSafe
public static interface ClientSideBeaconingConfiguration.Builder
extends SdkPojo, CopyableBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>

Method Summary

Modifier and Type	Method	Description
ClientSideBeaconingConfiguration.Builder	additionalEventTypes(Collection<BeaconEventType> additionalEventTypes)	The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on.
ClientSideBeaconingConfiguration.Builder	additionalEventTypes(BeaconEventType... additionalEventTypes)	The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on.
ClientSideBeaconingConfiguration.Builder	additionalEventTypesWithStrings(String... additionalEventTypes)	The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on.
ClientSideBeaconingConfiguration.Builder	additionalEventTypesWithStrings(Collection<String> additionalEventTypes)	The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on.
ClientSideBeaconingConfiguration.Builder	reportingMode(String reportingMode)	Specifies whether MediaTailor includes its beacons in the ad tracking response.
ClientSideBeaconingConfiguration.Builder	reportingMode(ClientSideBeaconingMode reportingMode)	Specifies whether MediaTailor includes its beacons in the ad tracking response.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

reportingMode

ClientSideBeaconingConfiguration.Builder reportingMode(String reportingMode)

Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:

• INSIGHTS – MediaTailor includes its beacons in the ad tracking response.

• DISABLED – MediaTailor doesn't include its beacons in the ad tracking response.

If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.

PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.

Parameters:

reportingMode - Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:

• INSIGHTS – MediaTailor includes its beacons in the ad tracking response.

• DISABLED – MediaTailor doesn't include its beacons in the ad tracking response.

If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.

PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClientSideBeaconingMode
• ClientSideBeaconingMode

reportingMode

ClientSideBeaconingConfiguration.Builder reportingMode(ClientSideBeaconingMode reportingMode)

Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:

• INSIGHTS – MediaTailor includes its beacons in the ad tracking response.

• DISABLED – MediaTailor doesn't include its beacons in the ad tracking response.

If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.

PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.

Parameters:

reportingMode - Specifies whether MediaTailor includes its beacons in the ad tracking response. Valid values, which are case-sensitive:

• INSIGHTS – MediaTailor includes its beacons in the ad tracking response.

• DISABLED – MediaTailor doesn't include its beacons in the ad tracking response.

If you send a ClientSide object, this setting is required. If you omit BeaconingConfiguration or ClientSide entirely, MediaTailor uses INSIGHTS.

PutPlaybackConfiguration replaces the whole playback configuration. To keep beaconing off, include DISABLED in every subsequent write.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ClientSideBeaconingMode
• ClientSideBeaconingMode

additionalEventTypesWithStrings

ClientSideBeaconingConfiguration.Builder additionalEventTypesWithStrings(Collection<String> additionalEventTypes)

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Parameters:

additionalEventTypes - The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalEventTypesWithStrings

ClientSideBeaconingConfiguration.Builder additionalEventTypesWithStrings(String... additionalEventTypes)

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Parameters:

additionalEventTypes - The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalEventTypes

ClientSideBeaconingConfiguration.Builder additionalEventTypes(Collection<BeaconEventType> additionalEventTypes)

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Parameters:

additionalEventTypes - The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalEventTypes

ClientSideBeaconingConfiguration.Builder additionalEventTypes(BeaconEventType... additionalEventTypes)

The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Parameters:

additionalEventTypes - The player operation events to report on, in addition to the ad progress events that MediaTailor always reports on. The default is an empty list. This parameter is valid only when ReportingMode is INSIGHTS. MediaTailor rejects the request if you specify a value while ReportingMode is DISABLED, or if you specify duplicate values.

Returns:

Returns a reference to this object so that method calls can be chained together.