software.amazon.awssdk.services.pinpointemail.model.DimensionValueSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pinpointemail Show documentation

The AWS Java SDK for Pinpoint Email module holds the client classes that are used for communicating with Pinpoint Email.

There is a newer version: 2.29.17

Show newest version

/*
 * 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.pinpointemail.model;

import java.util.EnumSet;
import java.util.Map;
import java.util.Set;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.utils.internal.EnumUtils;

/**
 * 
 * The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon
 * Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the
 * SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email
 * headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public enum DimensionValueSource {
    MESSAGE_TAG("MESSAGE_TAG"),

    EMAIL_HEADER("EMAIL_HEADER"),

    LINK_TAG("LINK_TAG"),

    UNKNOWN_TO_SDK_VERSION(null);

    private static final Map VALUE_MAP = EnumUtils.uniqueIndex(DimensionValueSource.class,
            DimensionValueSource::toString);

    private final String value;

    private DimensionValueSource(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 DimensionValueSource corresponding to the value
     */
    public static DimensionValueSource fromValue(String value) {
        if (value == null) {
            return null;
        }
        return VALUE_MAP.getOrDefault(value, 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 DimensionValueSource}s
     */
    public static Set knownValues() {
        Set knownValues = EnumSet.allOf(DimensionValueSource.class);
        knownValues.remove(UNKNOWN_TO_SDK_VERSION);
        return knownValues;
    }
}