Class ClientSideBeaconingConfiguration

java.lang.Object
software.amazon.awssdk.services.mediatailor.model.ClientSideBeaconingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ClientSideBeaconingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>

The beaconing settings that apply to client-side reporting sessions: whether MediaTailor includes its beacons in the ad tracking response, and which player operation events it reports on.

See Also:

  • Method Details

    • reportingMode

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

      If the service returns an enum value that is not available in the current SDK version, reportingMode will return ClientSideBeaconingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reportingModeAsString().

      Returns:
      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.

      See Also:

    • reportingModeAsString

      public final String reportingModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, reportingMode will return ClientSideBeaconingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reportingModeAsString().

      Returns:
      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.

      See Also:

    • additionalEventTypes

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalEventTypes() method.

      Returns:
      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.

    • hasAdditionalEventTypes

      public final boolean hasAdditionalEventTypes()
      For responses, this returns true if the service returned a value for the AdditionalEventTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalEventTypesAsStrings

      public final List<String> additionalEventTypesAsStrings()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalEventTypes() method.

      Returns:
      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.

    • toBuilder

      public ClientSideBeaconingConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClientSideBeaconingConfiguration.Builder,ClientSideBeaconingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ClientSideBeaconingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClientSideBeaconingConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.