software.amazon.awssdk.services.sesv2.model.DkimStatus Maven / Gradle / Ivy

Go to download
/*
 * 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.sesv2.model;

import static java.util.stream.Collectors.toSet;

import java.util.Set;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;

/**
 * 
 * The DKIM authentication status of the identity. The status can be one of the following:
 * 
 * 
 * 
 * 
 * PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in
 * the DNS configuration for the domain.
 * 
 * 
 * 
 * 
 * SUCCESS – The verification process completed successfully.
 * 
 * 
 * 
 * 
 * FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM
 * records in the DNS configuration of the domain.
 * 
 * 
 * 
 * 
 * TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication
 * status of the domain.
 * 
 * 
 * 
 * 
 * NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.
 * 
 * 
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public enum DkimStatus {
    PENDING("PENDING"),

    SUCCESS("SUCCESS"),

    FAILED("FAILED"),

    TEMPORARY_FAILURE("TEMPORARY_FAILURE"),

    NOT_STARTED("NOT_STARTED"),

    UNKNOWN_TO_SDK_VERSION(null);

    private final String value;

    private DkimStatus(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return String.valueOf(value);
    }

    /**
     * Use this in place of valueOf to convert the raw string returned by the service into the enum value.
     *
     * @param value
     *        real value
     * @return DkimStatus corresponding to the value
     */
    public static DkimStatus fromValue(String value) {
        if (value == null) {
            return null;
        }
        return Stream.of(DkimStatus.values()).filter(e -> e.toString().equals(value)).findFirst().orElse(UNKNOWN_TO_SDK_VERSION);
    }

    /**
     * Use this in place of {@link #values()} to return a {@link Set} of all values known to the SDK. This will return
     * all known enum values except {@link #UNKNOWN_TO_SDK_VERSION}.
     *
     * @return a {@link Set} of known {@link DkimStatus}s
     */
    public static Set knownValues() {
        return Stream.of(values()).filter(v -> v != UNKNOWN_TO_SDK_VERSION).collect(toSet());
    }
}