software.amazon.awssdk.services.pinpoint.model.ActivityResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpoint Show documentation
Show all versions of pinpoint Show documentation
The AWS Java SDK for Amazon Pinpoint module holds the client classes that are used for communicating
with Amazon Pinpoint Service
/*
* 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 an activity that was performed by a campaign.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ActivityResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField APPLICATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationId").getter(getter(ActivityResponse::applicationId)).setter(setter(Builder::applicationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationId").build()).build();
private static final SdkField CAMPAIGN_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CampaignId").getter(getter(ActivityResponse::campaignId)).setter(setter(Builder::campaignId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CampaignId").build()).build();
private static final SdkField END_FIELD = SdkField. builder(MarshallingType.STRING).memberName("End")
.getter(getter(ActivityResponse::end)).setter(setter(Builder::end))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("End").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(ActivityResponse::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField RESULT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Result")
.getter(getter(ActivityResponse::result)).setter(setter(Builder::result))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Result").build()).build();
private static final SdkField SCHEDULED_START_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ScheduledStart").getter(getter(ActivityResponse::scheduledStart))
.setter(setter(Builder::scheduledStart))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScheduledStart").build()).build();
private static final SdkField START_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Start")
.getter(getter(ActivityResponse::start)).setter(setter(Builder::start))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Start").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ActivityResponse::state)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField SUCCESSFUL_ENDPOINT_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("SuccessfulEndpointCount").getter(getter(ActivityResponse::successfulEndpointCount))
.setter(setter(Builder::successfulEndpointCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SuccessfulEndpointCount").build())
.build();
private static final SdkField TIMEZONES_COMPLETED_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TimezonesCompletedCount").getter(getter(ActivityResponse::timezonesCompletedCount))
.setter(setter(Builder::timezonesCompletedCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimezonesCompletedCount").build())
.build();
private static final SdkField TIMEZONES_TOTAL_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TimezonesTotalCount").getter(getter(ActivityResponse::timezonesTotalCount))
.setter(setter(Builder::timezonesTotalCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimezonesTotalCount").build())
.build();
private static final SdkField TOTAL_ENDPOINT_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("TotalEndpointCount").getter(getter(ActivityResponse::totalEndpointCount))
.setter(setter(Builder::totalEndpointCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TotalEndpointCount").build())
.build();
private static final SdkField TREATMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TreatmentId").getter(getter(ActivityResponse::treatmentId)).setter(setter(Builder::treatmentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TreatmentId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APPLICATION_ID_FIELD,
CAMPAIGN_ID_FIELD, END_FIELD, ID_FIELD, RESULT_FIELD, SCHEDULED_START_FIELD, START_FIELD, STATE_FIELD,
SUCCESSFUL_ENDPOINT_COUNT_FIELD, TIMEZONES_COMPLETED_COUNT_FIELD, TIMEZONES_TOTAL_COUNT_FIELD,
TOTAL_ENDPOINT_COUNT_FIELD, TREATMENT_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String applicationId;
private final String campaignId;
private final String end;
private final String id;
private final String result;
private final String scheduledStart;
private final String start;
private final String state;
private final Integer successfulEndpointCount;
private final Integer timezonesCompletedCount;
private final Integer timezonesTotalCount;
private final Integer totalEndpointCount;
private final String treatmentId;
private ActivityResponse(BuilderImpl builder) {
this.applicationId = builder.applicationId;
this.campaignId = builder.campaignId;
this.end = builder.end;
this.id = builder.id;
this.result = builder.result;
this.scheduledStart = builder.scheduledStart;
this.start = builder.start;
this.state = builder.state;
this.successfulEndpointCount = builder.successfulEndpointCount;
this.timezonesCompletedCount = builder.timezonesCompletedCount;
this.timezonesTotalCount = builder.timezonesTotalCount;
this.totalEndpointCount = builder.totalEndpointCount;
this.treatmentId = builder.treatmentId;
}
/**
*
* The unique identifier for the application that the campaign applies to.
*
*
* @return The unique identifier for the application that the campaign applies to.
*/
public final String applicationId() {
return applicationId;
}
/**
*
* The unique identifier for the campaign that the activity applies to.
*
*
* @return The unique identifier for the campaign that the activity applies to.
*/
public final String campaignId() {
return campaignId;
}
/**
*
* The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
*
*
* @return The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
*/
public final String end() {
return end;
}
/**
*
* The unique identifier for the activity.
*
*
* @return The unique identifier for the activity.
*/
public final String id() {
return id;
}
/**
*
* Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
*
*
* @return Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
*/
public final String result() {
return result;
}
/**
*
* The scheduled start time, in ISO 8601 format, for the activity.
*
*
* @return The scheduled start time, in ISO 8601 format, for the activity.
*/
public final String scheduledStart() {
return scheduledStart;
}
/**
*
* The actual start time, in ISO 8601 format, of the activity.
*
*
* @return The actual start time, in ISO 8601 format, of the activity.
*/
public final String start() {
return start;
}
/**
*
* The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and
* COMPLETED.
*
*
* @return The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED,
* CANCELLED, and COMPLETED.
*/
public final String state() {
return state;
}
/**
*
* The total number of endpoints that the campaign successfully delivered messages to.
*
*
* @return The total number of endpoints that the campaign successfully delivered messages to.
*/
public final Integer successfulEndpointCount() {
return successfulEndpointCount;
}
/**
*
* The total number of time zones that were completed.
*
*
* @return The total number of time zones that were completed.
*/
public final Integer timezonesCompletedCount() {
return timezonesCompletedCount;
}
/**
*
* The total number of unique time zones that are in the segment for the campaign.
*
*
* @return The total number of unique time zones that are in the segment for the campaign.
*/
public final Integer timezonesTotalCount() {
return timezonesTotalCount;
}
/**
*
* The total number of endpoints that the campaign attempted to deliver messages to.
*
*
* @return The total number of endpoints that the campaign attempted to deliver messages to.
*/
public final Integer totalEndpointCount() {
return totalEndpointCount;
}
/**
*
* The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a
* campaign that's used for A/B testing of a campaign.
*
*
* @return The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation
* of a campaign that's used for A/B testing of a campaign.
*/
public final String treatmentId() {
return treatmentId;
}
@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(applicationId());
hashCode = 31 * hashCode + Objects.hashCode(campaignId());
hashCode = 31 * hashCode + Objects.hashCode(end());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(result());
hashCode = 31 * hashCode + Objects.hashCode(scheduledStart());
hashCode = 31 * hashCode + Objects.hashCode(start());
hashCode = 31 * hashCode + Objects.hashCode(state());
hashCode = 31 * hashCode + Objects.hashCode(successfulEndpointCount());
hashCode = 31 * hashCode + Objects.hashCode(timezonesCompletedCount());
hashCode = 31 * hashCode + Objects.hashCode(timezonesTotalCount());
hashCode = 31 * hashCode + Objects.hashCode(totalEndpointCount());
hashCode = 31 * hashCode + Objects.hashCode(treatmentId());
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 ActivityResponse)) {
return false;
}
ActivityResponse other = (ActivityResponse) obj;
return Objects.equals(applicationId(), other.applicationId()) && Objects.equals(campaignId(), other.campaignId())
&& Objects.equals(end(), other.end()) && Objects.equals(id(), other.id())
&& Objects.equals(result(), other.result()) && Objects.equals(scheduledStart(), other.scheduledStart())
&& Objects.equals(start(), other.start()) && Objects.equals(state(), other.state())
&& Objects.equals(successfulEndpointCount(), other.successfulEndpointCount())
&& Objects.equals(timezonesCompletedCount(), other.timezonesCompletedCount())
&& Objects.equals(timezonesTotalCount(), other.timezonesTotalCount())
&& Objects.equals(totalEndpointCount(), other.totalEndpointCount())
&& Objects.equals(treatmentId(), other.treatmentId());
}
/**
* 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("ActivityResponse").add("ApplicationId", applicationId()).add("CampaignId", campaignId())
.add("End", end()).add("Id", id()).add("Result", result()).add("ScheduledStart", scheduledStart())
.add("Start", start()).add("State", state()).add("SuccessfulEndpointCount", successfulEndpointCount())
.add("TimezonesCompletedCount", timezonesCompletedCount()).add("TimezonesTotalCount", timezonesTotalCount())
.add("TotalEndpointCount", totalEndpointCount()).add("TreatmentId", treatmentId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationId":
return Optional.ofNullable(clazz.cast(applicationId()));
case "CampaignId":
return Optional.ofNullable(clazz.cast(campaignId()));
case "End":
return Optional.ofNullable(clazz.cast(end()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Result":
return Optional.ofNullable(clazz.cast(result()));
case "ScheduledStart":
return Optional.ofNullable(clazz.cast(scheduledStart()));
case "Start":
return Optional.ofNullable(clazz.cast(start()));
case "State":
return Optional.ofNullable(clazz.cast(state()));
case "SuccessfulEndpointCount":
return Optional.ofNullable(clazz.cast(successfulEndpointCount()));
case "TimezonesCompletedCount":
return Optional.ofNullable(clazz.cast(timezonesCompletedCount()));
case "TimezonesTotalCount":
return Optional.ofNullable(clazz.cast(timezonesTotalCount()));
case "TotalEndpointCount":
return Optional.ofNullable(clazz.cast(totalEndpointCount()));
case "TreatmentId":
return Optional.ofNullable(clazz.cast(treatmentId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ActivityResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier for the application that the campaign applies to.
*
*
* @param applicationId
* The unique identifier for the application that the campaign applies to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationId(String applicationId);
/**
*
* The unique identifier for the campaign that the activity applies to.
*
*
* @param campaignId
* The unique identifier for the campaign that the activity applies to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder campaignId(String campaignId);
/**
*
* The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
*
*
* @param end
* The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder end(String end);
/**
*
* The unique identifier for the activity.
*
*
* @param id
* The unique identifier for the activity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
*
*
* @param result
* Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder result(String result);
/**
*
* The scheduled start time, in ISO 8601 format, for the activity.
*
*
* @param scheduledStart
* The scheduled start time, in ISO 8601 format, for the activity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledStart(String scheduledStart);
/**
*
* The actual start time, in ISO 8601 format, of the activity.
*
*
* @param start
* The actual start time, in ISO 8601 format, of the activity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder start(String start);
/**
*
* The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED,
* and COMPLETED.
*
*
* @param state
* The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED,
* CANCELLED, and COMPLETED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder state(String state);
/**
*
* The total number of endpoints that the campaign successfully delivered messages to.
*
*
* @param successfulEndpointCount
* The total number of endpoints that the campaign successfully delivered messages to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder successfulEndpointCount(Integer successfulEndpointCount);
/**
*
* The total number of time zones that were completed.
*
*
* @param timezonesCompletedCount
* The total number of time zones that were completed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timezonesCompletedCount(Integer timezonesCompletedCount);
/**
*
* The total number of unique time zones that are in the segment for the campaign.
*
*
* @param timezonesTotalCount
* The total number of unique time zones that are in the segment for the campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timezonesTotalCount(Integer timezonesTotalCount);
/**
*
* The total number of endpoints that the campaign attempted to deliver messages to.
*
*
* @param totalEndpointCount
* The total number of endpoints that the campaign attempted to deliver messages to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder totalEndpointCount(Integer totalEndpointCount);
/**
*
* The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of
* a campaign that's used for A/B testing of a campaign.
*
*
* @param treatmentId
* The unique identifier for the campaign treatment that the activity applies to. A treatment is a
* variation of a campaign that's used for A/B testing of a campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder treatmentId(String treatmentId);
}
static final class BuilderImpl implements Builder {
private String applicationId;
private String campaignId;
private String end;
private String id;
private String result;
private String scheduledStart;
private String start;
private String state;
private Integer successfulEndpointCount;
private Integer timezonesCompletedCount;
private Integer timezonesTotalCount;
private Integer totalEndpointCount;
private String treatmentId;
private BuilderImpl() {
}
private BuilderImpl(ActivityResponse model) {
applicationId(model.applicationId);
campaignId(model.campaignId);
end(model.end);
id(model.id);
result(model.result);
scheduledStart(model.scheduledStart);
start(model.start);
state(model.state);
successfulEndpointCount(model.successfulEndpointCount);
timezonesCompletedCount(model.timezonesCompletedCount);
timezonesTotalCount(model.timezonesTotalCount);
totalEndpointCount(model.totalEndpointCount);
treatmentId(model.treatmentId);
}
public final String getApplicationId() {
return applicationId;
}
@Override
public final Builder applicationId(String applicationId) {
this.applicationId = applicationId;
return this;
}
public final void setApplicationId(String applicationId) {
this.applicationId = applicationId;
}
public final String getCampaignId() {
return campaignId;
}
@Override
public final Builder campaignId(String campaignId) {
this.campaignId = campaignId;
return this;
}
public final void setCampaignId(String campaignId) {
this.campaignId = campaignId;
}
public final String getEnd() {
return end;
}
@Override
public final Builder end(String end) {
this.end = end;
return this;
}
public final void setEnd(String end) {
this.end = end;
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
public final String getResult() {
return result;
}
@Override
public final Builder result(String result) {
this.result = result;
return this;
}
public final void setResult(String result) {
this.result = result;
}
public final String getScheduledStart() {
return scheduledStart;
}
@Override
public final Builder scheduledStart(String scheduledStart) {
this.scheduledStart = scheduledStart;
return this;
}
public final void setScheduledStart(String scheduledStart) {
this.scheduledStart = scheduledStart;
}
public final String getStart() {
return start;
}
@Override
public final Builder start(String start) {
this.start = start;
return this;
}
public final void setStart(String start) {
this.start = start;
}
public final String getState() {
return state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
public final void setState(String state) {
this.state = state;
}
public final Integer getSuccessfulEndpointCount() {
return successfulEndpointCount;
}
@Override
public final Builder successfulEndpointCount(Integer successfulEndpointCount) {
this.successfulEndpointCount = successfulEndpointCount;
return this;
}
public final void setSuccessfulEndpointCount(Integer successfulEndpointCount) {
this.successfulEndpointCount = successfulEndpointCount;
}
public final Integer getTimezonesCompletedCount() {
return timezonesCompletedCount;
}
@Override
public final Builder timezonesCompletedCount(Integer timezonesCompletedCount) {
this.timezonesCompletedCount = timezonesCompletedCount;
return this;
}
public final void setTimezonesCompletedCount(Integer timezonesCompletedCount) {
this.timezonesCompletedCount = timezonesCompletedCount;
}
public final Integer getTimezonesTotalCount() {
return timezonesTotalCount;
}
@Override
public final Builder timezonesTotalCount(Integer timezonesTotalCount) {
this.timezonesTotalCount = timezonesTotalCount;
return this;
}
public final void setTimezonesTotalCount(Integer timezonesTotalCount) {
this.timezonesTotalCount = timezonesTotalCount;
}
public final Integer getTotalEndpointCount() {
return totalEndpointCount;
}
@Override
public final Builder totalEndpointCount(Integer totalEndpointCount) {
this.totalEndpointCount = totalEndpointCount;
return this;
}
public final void setTotalEndpointCount(Integer totalEndpointCount) {
this.totalEndpointCount = totalEndpointCount;
}
public final String getTreatmentId() {
return treatmentId;
}
@Override
public final Builder treatmentId(String treatmentId) {
this.treatmentId = treatmentId;
return this;
}
public final void setTreatmentId(String treatmentId) {
this.treatmentId = treatmentId;
}
@Override
public ActivityResponse build() {
return new ActivityResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}