KantarWatermarkSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.KantarWatermarkSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KantarWatermarkSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KantarWatermarkSettings()

Constructors
Constructor and Description
`KantarWatermarkSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KantarWatermarkSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChannelName()` Provide an audio channel name from your Kantar audio license.
`String`	`getContentReference()` Specify a unique identifier for Kantar to use for this piece of content.
`String`	`getCredentialsSecretName()` Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored.
`Double`	`getFileOffset()` Optional.
`Integer`	`getKantarLicenseId()` Provide your Kantar license ID number.
`String`	`getKantarServerUrl()` Provide the HTTPS endpoint to the Kantar server.
`String`	`getLogDestination()` Optional.
`String`	`getMetadata3()` You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking.
`String`	`getMetadata4()` Additional metadata that MediaConvert sends to Kantar.
`String`	`getMetadata5()` Additional metadata that MediaConvert sends to Kantar.
`String`	`getMetadata6()` Additional metadata that MediaConvert sends to Kantar.
`String`	`getMetadata7()` Additional metadata that MediaConvert sends to Kantar.
`String`	`getMetadata8()` Additional metadata that MediaConvert sends to Kantar.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelName(String channelName)` Provide an audio channel name from your Kantar audio license.
`void`	`setContentReference(String contentReference)` Specify a unique identifier for Kantar to use for this piece of content.
`void`	`setCredentialsSecretName(String credentialsSecretName)` Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored.
`void`	`setFileOffset(Double fileOffset)` Optional.
`void`	`setKantarLicenseId(Integer kantarLicenseId)` Provide your Kantar license ID number.
`void`	`setKantarServerUrl(String kantarServerUrl)` Provide the HTTPS endpoint to the Kantar server.
`void`	`setLogDestination(String logDestination)` Optional.
`void`	`setMetadata3(String metadata3)` You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking.
`void`	`setMetadata4(String metadata4)` Additional metadata that MediaConvert sends to Kantar.
`void`	`setMetadata5(String metadata5)` Additional metadata that MediaConvert sends to Kantar.
`void`	`setMetadata6(String metadata6)` Additional metadata that MediaConvert sends to Kantar.
`void`	`setMetadata7(String metadata7)` Additional metadata that MediaConvert sends to Kantar.
`void`	`setMetadata8(String metadata8)` Additional metadata that MediaConvert sends to Kantar.
`String`	`toString()` Returns a string representation of this object.
`KantarWatermarkSettings`	`withChannelName(String channelName)` Provide an audio channel name from your Kantar audio license.
`KantarWatermarkSettings`	`withContentReference(String contentReference)` Specify a unique identifier for Kantar to use for this piece of content.
`KantarWatermarkSettings`	`withCredentialsSecretName(String credentialsSecretName)` Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored.
`KantarWatermarkSettings`	`withFileOffset(Double fileOffset)` Optional.
`KantarWatermarkSettings`	`withKantarLicenseId(Integer kantarLicenseId)` Provide your Kantar license ID number.
`KantarWatermarkSettings`	`withKantarServerUrl(String kantarServerUrl)` Provide the HTTPS endpoint to the Kantar server.
`KantarWatermarkSettings`	`withLogDestination(String logDestination)` Optional.
`KantarWatermarkSettings`	`withMetadata3(String metadata3)` You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking.
`KantarWatermarkSettings`	`withMetadata4(String metadata4)` Additional metadata that MediaConvert sends to Kantar.
`KantarWatermarkSettings`	`withMetadata5(String metadata5)` Additional metadata that MediaConvert sends to Kantar.
`KantarWatermarkSettings`	`withMetadata6(String metadata6)` Additional metadata that MediaConvert sends to Kantar.
`KantarWatermarkSettings`	`withMetadata7(String metadata7)` Additional metadata that MediaConvert sends to Kantar.
`KantarWatermarkSettings`	`withMetadata8(String metadata8)` Additional metadata that MediaConvert sends to Kantar.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KantarWatermarkSettings
```
public KantarWatermarkSettings()
```
- Method Detail
  - setChannelName
```
public void setChannelName(String channelName)
```
    Provide an audio channel name from your Kantar audio license.
    
    Parameters:
    
    channelName - Provide an audio channel name from your Kantar audio license.
  - getChannelName
```
public String getChannelName()
```
    Provide an audio channel name from your Kantar audio license.
    
    Returns:
    
    Provide an audio channel name from your Kantar audio license.
  - withChannelName
```
public KantarWatermarkSettings withChannelName(String channelName)
```
    Provide an audio channel name from your Kantar audio license.
    
    Parameters:
    
    channelName - Provide an audio channel name from your Kantar audio license.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentReference
```
public void setContentReference(String contentReference)
```
    Specify a unique identifier for Kantar to use for this piece of content.
    
    Parameters:
    
    contentReference - Specify a unique identifier for Kantar to use for this piece of content.
  - getContentReference
```
public String getContentReference()
```
    Specify a unique identifier for Kantar to use for this piece of content.
    
    Returns:
    
    Specify a unique identifier for Kantar to use for this piece of content.
  - withContentReference
```
public KantarWatermarkSettings withContentReference(String contentReference)
```
    Specify a unique identifier for Kantar to use for this piece of content.
    
    Parameters:
    
    contentReference - Specify a unique identifier for Kantar to use for this piece of content.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCredentialsSecretName
```
public void setCredentialsSecretName(String credentialsSecretName)
```
    Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com /mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
    
    Parameters:
    
    credentialsSecretName - Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws .amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets- manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
  - getCredentialsSecretName
```
public String getCredentialsSecretName()
```
    Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com /mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
    
    Returns:
    
    Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs. aws.amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets -manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
  - withCredentialsSecretName
```
public KantarWatermarkSettings withCredentialsSecretName(String credentialsSecretName)
```
    Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws.amazon.com /mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets-manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
    
    Parameters:
    
    credentialsSecretName - Provide the name of the AWS Secrets Manager secret where your Kantar credentials are stored. Note that your MediaConvert service role must provide access to this secret. For more information, see https://docs.aws .amazon.com/mediaconvert/latest/ug/granting-permissions-for-mediaconvert-to-access-secrets- manager-secret.html. For instructions on creating a secret, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html, in the AWS Secrets Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileOffset
```
public void setFileOffset(Double fileOffset)
```
    Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
    
    Parameters:
    
    fileOffset - Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
  - getFileOffset
```
public Double getFileOffset()
```
    Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
    
    Returns:
    
    Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
  - withFileOffset
```
public KantarWatermarkSettings withFileOffset(Double fileOffset)
```
    Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
    
    Parameters:
    
    fileOffset - Optional. Specify an offset, in whole seconds, from the start of your output and the beginning of the watermarking. When you don't specify an offset, Kantar defaults to zero.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKantarLicenseId
```
public void setKantarLicenseId(Integer kantarLicenseId)
```
    Provide your Kantar license ID number. You should get this number from Kantar.
    
    Parameters:
    
    kantarLicenseId - Provide your Kantar license ID number. You should get this number from Kantar.
  - getKantarLicenseId
```
public Integer getKantarLicenseId()
```
    Provide your Kantar license ID number. You should get this number from Kantar.
    
    Returns:
    
    Provide your Kantar license ID number. You should get this number from Kantar.
  - withKantarLicenseId
```
public KantarWatermarkSettings withKantarLicenseId(Integer kantarLicenseId)
```
    Provide your Kantar license ID number. You should get this number from Kantar.
    
    Parameters:
    
    kantarLicenseId - Provide your Kantar license ID number. You should get this number from Kantar.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKantarServerUrl
```
public void setKantarServerUrl(String kantarServerUrl)
```
    Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
    
    Parameters:
    
    kantarServerUrl - Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
  - getKantarServerUrl
```
public String getKantarServerUrl()
```
    Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
    
    Returns:
    
    Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
  - withKantarServerUrl
```
public KantarWatermarkSettings withKantarServerUrl(String kantarServerUrl)
```
    Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
    
    Parameters:
    
    kantarServerUrl - Provide the HTTPS endpoint to the Kantar server. You should get this endpoint from Kantar.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogDestination
```
public void setLogDestination(String logDestination)
```
    Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
    
    Parameters:
    
    logDestination - Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
  - getLogDestination
```
public String getLogDestination()
```
    Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
    
    Returns:
    
    Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
  - withLogDestination
```
public KantarWatermarkSettings withLogDestination(String logDestination)
```
    Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
    
    Parameters:
    
    logDestination - Optional. Specify the Amazon S3 bucket where you want MediaConvert to store your Kantar watermark XML logs. When you don't specify a bucket, MediaConvert doesn't save these logs. Note that your MediaConvert service role must provide access to this location. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata3
```
public void setMetadata3(String metadata3)
```
    You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
    
    Parameters:
    
    metadata3 - You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
  - getMetadata3
```
public String getMetadata3()
```
    You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
    
    Returns:
    
    You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
  - withMetadata3
```
public KantarWatermarkSettings withMetadata3(String metadata3)
```
    You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
    
    Parameters:
    
    metadata3 - You can optionally use this field to specify the first timestamp that Kantar embeds during watermarking. Kantar suggests that you be very cautious when using this Kantar feature, and that you use it only on channels that are managed specifically for use with this feature by your Audience Measurement Operator. For more information about this feature, contact Kantar technical support.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata4
```
public void setMetadata4(String metadata4)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata4 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - getMetadata4
```
public String getMetadata4()
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - withMetadata4
```
public KantarWatermarkSettings withMetadata4(String metadata4)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata4 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata5
```
public void setMetadata5(String metadata5)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata5 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - getMetadata5
```
public String getMetadata5()
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - withMetadata5
```
public KantarWatermarkSettings withMetadata5(String metadata5)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata5 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata6
```
public void setMetadata6(String metadata6)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata6 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - getMetadata6
```
public String getMetadata6()
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - withMetadata6
```
public KantarWatermarkSettings withMetadata6(String metadata6)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata6 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata7
```
public void setMetadata7(String metadata7)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata7 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - getMetadata7
```
public String getMetadata7()
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - withMetadata7
```
public KantarWatermarkSettings withMetadata7(String metadata7)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata7 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadata8
```
public void setMetadata8(String metadata8)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata8 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - getMetadata8
```
public String getMetadata8()
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
  - withMetadata8
```
public KantarWatermarkSettings withMetadata8(String metadata8)
```
    Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Parameters:
    
    metadata8 - Additional metadata that MediaConvert sends to Kantar. Maximum length is 50 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 KantarWatermarkSettings 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class KantarWatermarkSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KantarWatermarkSettings

Method Detail

setChannelName

getChannelName

withChannelName

setContentReference

getContentReference

withContentReference

setCredentialsSecretName

getCredentialsSecretName

withCredentialsSecretName

setFileOffset

getFileOffset

withFileOffset

setKantarLicenseId

getKantarLicenseId

withKantarLicenseId

setKantarServerUrl

getKantarServerUrl

withKantarServerUrl

setLogDestination

getLogDestination

withLogDestination

setMetadata3

getMetadata3

withMetadata3

setMetadata4

getMetadata4

withMetadata4

setMetadata5

getMetadata5

withMetadata5

setMetadata6

getMetadata6

withMetadata6

setMetadata7

getMetadata7

withMetadata7

setMetadata8

getMetadata8

withMetadata8

toString

equals

hashCode

clone

marshall