software.amazon.awssdk.services.mediapackage.model.CmafEncryption Maven / Gradle / Ivy
Show all versions of mediapackage Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.mediapackage.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
* A Common Media Application Format (CMAF) encryption configuration.
*/
@Generated("software.amazon.awssdk:codegen")
public final class CmafEncryption implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CONSTANT_INITIALIZATION_VECTOR_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ConstantInitializationVector")
.getter(getter(CmafEncryption::constantInitializationVector))
.setter(setter(Builder::constantInitializationVector))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("constantInitializationVector")
.build()).build();
private static final SdkField ENCRYPTION_METHOD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EncryptionMethod").getter(getter(CmafEncryption::encryptionMethodAsString))
.setter(setter(Builder::encryptionMethod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("encryptionMethod").build()).build();
private static final SdkField KEY_ROTATION_INTERVAL_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("KeyRotationIntervalSeconds")
.getter(getter(CmafEncryption::keyRotationIntervalSeconds))
.setter(setter(Builder::keyRotationIntervalSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("keyRotationIntervalSeconds").build())
.build();
private static final SdkField SPEKE_KEY_PROVIDER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SpekeKeyProvider")
.getter(getter(CmafEncryption::spekeKeyProvider)).setter(setter(Builder::spekeKeyProvider))
.constructor(SpekeKeyProvider::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("spekeKeyProvider").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
CONSTANT_INITIALIZATION_VECTOR_FIELD, ENCRYPTION_METHOD_FIELD, KEY_ROTATION_INTERVAL_SECONDS_FIELD,
SPEKE_KEY_PROVIDER_FIELD));
private static final long serialVersionUID = 1L;
private final String constantInitializationVector;
private final String encryptionMethod;
private final Integer keyRotationIntervalSeconds;
private final SpekeKeyProvider spekeKeyProvider;
private CmafEncryption(BuilderImpl builder) {
this.constantInitializationVector = builder.constantInitializationVector;
this.encryptionMethod = builder.encryptionMethod;
this.keyRotationIntervalSeconds = builder.keyRotationIntervalSeconds;
this.spekeKeyProvider = builder.spekeKeyProvider;
}
/**
* An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for
* encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector
* (IV).
*
* @return An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the
* key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant
* initialization vector (IV).
*/
public final String constantInitializationVector() {
return constantInitializationVector;
}
/**
* Returns the value of the EncryptionMethod property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encryptionMethod}
* will return {@link CmafEncryptionMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #encryptionMethodAsString}.
*
*
* @return The value of the EncryptionMethod property for this object.
* @see CmafEncryptionMethod
*/
public final CmafEncryptionMethod encryptionMethod() {
return CmafEncryptionMethod.fromValue(encryptionMethod);
}
/**
* Returns the value of the EncryptionMethod property for this object.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encryptionMethod}
* will return {@link CmafEncryptionMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #encryptionMethodAsString}.
*
*
* @return The value of the EncryptionMethod property for this object.
* @see CmafEncryptionMethod
*/
public final String encryptionMethodAsString() {
return encryptionMethod;
}
/**
* Time (in seconds) between each encryption key rotation.
*
* @return Time (in seconds) between each encryption key rotation.
*/
public final Integer keyRotationIntervalSeconds() {
return keyRotationIntervalSeconds;
}
/**
* Returns the value of the SpekeKeyProvider property for this object.
*
* @return The value of the SpekeKeyProvider property for this object.
*/
public final SpekeKeyProvider spekeKeyProvider() {
return spekeKeyProvider;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(constantInitializationVector());
hashCode = 31 * hashCode + Objects.hashCode(encryptionMethodAsString());
hashCode = 31 * hashCode + Objects.hashCode(keyRotationIntervalSeconds());
hashCode = 31 * hashCode + Objects.hashCode(spekeKeyProvider());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CmafEncryption)) {
return false;
}
CmafEncryption other = (CmafEncryption) obj;
return Objects.equals(constantInitializationVector(), other.constantInitializationVector())
&& Objects.equals(encryptionMethodAsString(), other.encryptionMethodAsString())
&& Objects.equals(keyRotationIntervalSeconds(), other.keyRotationIntervalSeconds())
&& Objects.equals(spekeKeyProvider(), other.spekeKeyProvider());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CmafEncryption").add("ConstantInitializationVector", constantInitializationVector())
.add("EncryptionMethod", encryptionMethodAsString())
.add("KeyRotationIntervalSeconds", keyRotationIntervalSeconds()).add("SpekeKeyProvider", spekeKeyProvider())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConstantInitializationVector":
return Optional.ofNullable(clazz.cast(constantInitializationVector()));
case "EncryptionMethod":
return Optional.ofNullable(clazz.cast(encryptionMethodAsString()));
case "KeyRotationIntervalSeconds":
return Optional.ofNullable(clazz.cast(keyRotationIntervalSeconds()));
case "SpekeKeyProvider":
return Optional.ofNullable(clazz.cast(spekeKeyProvider()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CmafEncryption) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key
* for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization
* vector (IV).
*
* @param constantInitializationVector
* An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with
* the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant
* initialization vector (IV).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder constantInitializationVector(String constantInitializationVector);
/**
* Sets the value of the EncryptionMethod property for this object.
*
* @param encryptionMethod
* The new value for the EncryptionMethod property for this object.
* @see CmafEncryptionMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see CmafEncryptionMethod
*/
Builder encryptionMethod(String encryptionMethod);
/**
* Sets the value of the EncryptionMethod property for this object.
*
* @param encryptionMethod
* The new value for the EncryptionMethod property for this object.
* @see CmafEncryptionMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see CmafEncryptionMethod
*/
Builder encryptionMethod(CmafEncryptionMethod encryptionMethod);
/**
* Time (in seconds) between each encryption key rotation.
*
* @param keyRotationIntervalSeconds
* Time (in seconds) between each encryption key rotation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyRotationIntervalSeconds(Integer keyRotationIntervalSeconds);
/**
* Sets the value of the SpekeKeyProvider property for this object.
*
* @param spekeKeyProvider
* The new value for the SpekeKeyProvider property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder spekeKeyProvider(SpekeKeyProvider spekeKeyProvider);
/**
* Sets the value of the SpekeKeyProvider property for this object.
*
* This is a convenience method that creates an instance of the {@link SpekeKeyProvider.Builder} avoiding the
* need to create one manually via {@link SpekeKeyProvider#builder()}.
*
*
* When the {@link Consumer} completes, {@link SpekeKeyProvider.Builder#build()} is called immediately and its
* result is passed to {@link #spekeKeyProvider(SpekeKeyProvider)}.
*
* @param spekeKeyProvider
* a consumer that will call methods on {@link SpekeKeyProvider.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #spekeKeyProvider(SpekeKeyProvider)
*/
default Builder spekeKeyProvider(Consumer spekeKeyProvider) {
return spekeKeyProvider(SpekeKeyProvider.builder().applyMutation(spekeKeyProvider).build());
}
}
static final class BuilderImpl implements Builder {
private String constantInitializationVector;
private String encryptionMethod;
private Integer keyRotationIntervalSeconds;
private SpekeKeyProvider spekeKeyProvider;
private BuilderImpl() {
}
private BuilderImpl(CmafEncryption model) {
constantInitializationVector(model.constantInitializationVector);
encryptionMethod(model.encryptionMethod);
keyRotationIntervalSeconds(model.keyRotationIntervalSeconds);
spekeKeyProvider(model.spekeKeyProvider);
}
public final String getConstantInitializationVector() {
return constantInitializationVector;
}
public final void setConstantInitializationVector(String constantInitializationVector) {
this.constantInitializationVector = constantInitializationVector;
}
@Override
public final Builder constantInitializationVector(String constantInitializationVector) {
this.constantInitializationVector = constantInitializationVector;
return this;
}
public final String getEncryptionMethod() {
return encryptionMethod;
}
public final void setEncryptionMethod(String encryptionMethod) {
this.encryptionMethod = encryptionMethod;
}
@Override
public final Builder encryptionMethod(String encryptionMethod) {
this.encryptionMethod = encryptionMethod;
return this;
}
@Override
public final Builder encryptionMethod(CmafEncryptionMethod encryptionMethod) {
this.encryptionMethod(encryptionMethod == null ? null : encryptionMethod.toString());
return this;
}
public final Integer getKeyRotationIntervalSeconds() {
return keyRotationIntervalSeconds;
}
public final void setKeyRotationIntervalSeconds(Integer keyRotationIntervalSeconds) {
this.keyRotationIntervalSeconds = keyRotationIntervalSeconds;
}
@Override
public final Builder keyRotationIntervalSeconds(Integer keyRotationIntervalSeconds) {
this.keyRotationIntervalSeconds = keyRotationIntervalSeconds;
return this;
}
public final SpekeKeyProvider.Builder getSpekeKeyProvider() {
return spekeKeyProvider != null ? spekeKeyProvider.toBuilder() : null;
}
public final void setSpekeKeyProvider(SpekeKeyProvider.BuilderImpl spekeKeyProvider) {
this.spekeKeyProvider = spekeKeyProvider != null ? spekeKeyProvider.build() : null;
}
@Override
public final Builder spekeKeyProvider(SpekeKeyProvider spekeKeyProvider) {
this.spekeKeyProvider = spekeKeyProvider;
return this;
}
@Override
public CmafEncryption build() {
return new CmafEncryption(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}