software.amazon.awssdk.services.ses.model.DeliveryOptions Maven / Gradle / Ivy
Show all versions of ses 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.ses.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.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;
/**
*
* Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeliveryOptions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TLS_POLICY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TlsPolicy").getter(getter(DeliveryOptions::tlsPolicyAsString)).setter(setter(Builder::tlsPolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TlsPolicy").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TLS_POLICY_FIELD));
private static final long serialVersionUID = 1L;
private final String tlsPolicy;
private DeliveryOptions(BuilderImpl builder) {
this.tlsPolicy = builder.tlsPolicy;
}
/**
*
* Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If
* the value is Require, messages are only delivered if a TLS connection can be established. If the
* value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #tlsPolicy} will
* return {@link TlsPolicy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #tlsPolicyAsString}.
*
*
* @return Specifies whether messages that use the configuration set are required to use Transport Layer Security
* (TLS). If the value is Require, messages are only delivered if a TLS connection can be
* established. If the value is Optional, messages can be delivered in plain text if a TLS
* connection can't be established.
* @see TlsPolicy
*/
public final TlsPolicy tlsPolicy() {
return TlsPolicy.fromValue(tlsPolicy);
}
/**
*
* Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If
* the value is Require, messages are only delivered if a TLS connection can be established. If the
* value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #tlsPolicy} will
* return {@link TlsPolicy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #tlsPolicyAsString}.
*
*
* @return Specifies whether messages that use the configuration set are required to use Transport Layer Security
* (TLS). If the value is Require, messages are only delivered if a TLS connection can be
* established. If the value is Optional, messages can be delivered in plain text if a TLS
* connection can't be established.
* @see TlsPolicy
*/
public final String tlsPolicyAsString() {
return tlsPolicy;
}
@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(tlsPolicyAsString());
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 DeliveryOptions)) {
return false;
}
DeliveryOptions other = (DeliveryOptions) obj;
return Objects.equals(tlsPolicyAsString(), other.tlsPolicyAsString());
}
/**
* 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("DeliveryOptions").add("TlsPolicy", tlsPolicyAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TlsPolicy":
return Optional.ofNullable(clazz.cast(tlsPolicyAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeliveryOptions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
* If the value is Require, messages are only delivered if a TLS connection can be established. If
* the value is Optional, messages can be delivered in plain text if a TLS connection can't be
* established.
*
*
* @param tlsPolicy
* Specifies whether messages that use the configuration set are required to use Transport Layer Security
* (TLS). If the value is Require, messages are only delivered if a TLS connection can be
* established. If the value is Optional, messages can be delivered in plain text if a TLS
* connection can't be established.
* @see TlsPolicy
* @return Returns a reference to this object so that method calls can be chained together.
* @see TlsPolicy
*/
Builder tlsPolicy(String tlsPolicy);
/**
*
* Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
* If the value is Require, messages are only delivered if a TLS connection can be established. If
* the value is Optional, messages can be delivered in plain text if a TLS connection can't be
* established.
*
*
* @param tlsPolicy
* Specifies whether messages that use the configuration set are required to use Transport Layer Security
* (TLS). If the value is Require, messages are only delivered if a TLS connection can be
* established. If the value is Optional, messages can be delivered in plain text if a TLS
* connection can't be established.
* @see TlsPolicy
* @return Returns a reference to this object so that method calls can be chained together.
* @see TlsPolicy
*/
Builder tlsPolicy(TlsPolicy tlsPolicy);
}
static final class BuilderImpl implements Builder {
private String tlsPolicy;
private BuilderImpl() {
}
private BuilderImpl(DeliveryOptions model) {
tlsPolicy(model.tlsPolicy);
}
public final String getTlsPolicy() {
return tlsPolicy;
}
public final void setTlsPolicy(String tlsPolicy) {
this.tlsPolicy = tlsPolicy;
}
@Override
public final Builder tlsPolicy(String tlsPolicy) {
this.tlsPolicy = tlsPolicy;
return this;
}
@Override
public final Builder tlsPolicy(TlsPolicy tlsPolicy) {
this.tlsPolicy(tlsPolicy == null ? null : tlsPolicy.toString());
return this;
}
@Override
public DeliveryOptions build() {
return new DeliveryOptions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}