com.amazonaws.services.mediatailor.model

Class AvailMatchingCriteria

java.lang.Object

com.amazonaws.services.mediatailor.model.AvailMatchingCriteria

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AvailMatchingCriteria
extends Object
implements Serializable, Cloneable, StructuredPojo

MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.

As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]& ;duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.

You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AvailMatchingCriteria()

Method Summary

Modifier and Type	Method and Description
AvailMatchingCriteria	clone()
boolean	equals(Object obj)
String	getDynamicVariable() The dynamic variable(s) that MediaTailor should use as avail matching criteria.
String	getOperator() For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDynamicVariable(String dynamicVariable) The dynamic variable(s) that MediaTailor should use as avail matching criteria.
void	setOperator(String operator) For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
String	toString() Returns a string representation of this object.
AvailMatchingCriteria	withDynamicVariable(String dynamicVariable) The dynamic variable(s) that MediaTailor should use as avail matching criteria.
AvailMatchingCriteria	withOperator(Operator operator) For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
AvailMatchingCriteria	withOperator(String operator) For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AvailMatchingCriteria

public AvailMatchingCriteria()

Method Detail

setDynamicVariable

public void setDynamicVariable(String dynamicVariable)

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Parameters:

dynamicVariable - The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

getDynamicVariable

public String getDynamicVariable()

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Returns:

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

withDynamicVariable

public AvailMatchingCriteria withDynamicVariable(String dynamicVariable)

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Parameters:

dynamicVariable - The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Returns:

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

setOperator

public void setOperator(String operator)

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Parameters:

operator - For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See Also:

Operator

getOperator

public String getOperator()

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Returns:

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See Also:

Operator

withOperator

public AvailMatchingCriteria withOperator(String operator)

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Parameters:

operator - For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Returns:

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

See Also:

Operator

withOperator

public AvailMatchingCriteria withOperator(Operator operator)

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Parameters:

operator - For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

Returns:

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

See Also:

Operator

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AvailMatchingCriteria clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.