software.amazon.awssdk.services.pinpoint.model.CampaignState Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.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;
/**
*
* Provides information about the status of a campaign.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CampaignState implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CAMPAIGN_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CampaignStatus").getter(getter(CampaignState::campaignStatusAsString))
.setter(setter(Builder::campaignStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CampaignStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CAMPAIGN_STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String campaignStatus;
private CampaignState(BuilderImpl builder) {
this.campaignStatus = builder.campaignStatus;
}
/**
*
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
*
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a
* status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a
* status of DELETED.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #campaignStatus}
* will return {@link CampaignStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #campaignStatusAsString}.
*
*
* @return The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments
* have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign
* fails and has a status of DELETED.
* @see CampaignStatus
*/
public final CampaignStatus campaignStatus() {
return CampaignStatus.fromValue(campaignStatus);
}
/**
*
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
*
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a
* status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a
* status of DELETED.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #campaignStatus}
* will return {@link CampaignStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #campaignStatusAsString}.
*
*
* @return The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments
* have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign
* fails and has a status of DELETED.
* @see CampaignStatus
*/
public final String campaignStatusAsString() {
return campaignStatus;
}
@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(campaignStatusAsString());
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 CampaignState)) {
return false;
}
CampaignState other = (CampaignState) obj;
return Objects.equals(campaignStatusAsString(), other.campaignStatusAsString());
}
/**
* 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("CampaignState").add("CampaignStatus", campaignStatusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CampaignStatus":
return Optional.ofNullable(clazz.cast(campaignStatusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CampaignState) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a
* status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has
* a status of DELETED.
*
*
* @param campaignStatus
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments
* have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign
* fails and has a status of DELETED.
* @see CampaignStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see CampaignStatus
*/
Builder campaignStatus(String campaignStatus);
/**
*
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a
* status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has
* a status of DELETED.
*
*
* @param campaignStatus
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test
* campaign.
*
* If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments
* have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign
* fails and has a status of DELETED.
* @see CampaignStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see CampaignStatus
*/
Builder campaignStatus(CampaignStatus campaignStatus);
}
static final class BuilderImpl implements Builder {
private String campaignStatus;
private BuilderImpl() {
}
private BuilderImpl(CampaignState model) {
campaignStatus(model.campaignStatus);
}
public final String getCampaignStatus() {
return campaignStatus;
}
public final void setCampaignStatus(String campaignStatus) {
this.campaignStatus = campaignStatus;
}
@Override
public final Builder campaignStatus(String campaignStatus) {
this.campaignStatus = campaignStatus;
return this;
}
@Override
public final Builder campaignStatus(CampaignStatus campaignStatus) {
this.campaignStatus(campaignStatus == null ? null : campaignStatus.toString());
return this;
}
@Override
public CampaignState build() {
return new CampaignState(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}