/* * Copyright 2018-2023 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 com.amazonaws.services.pinpoint.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides information about an activity that was performed by a campaign. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ActivityResponse implements Serializable, Cloneable, StructuredPojo { /** ** The unique identifier for the application that the campaign applies to. *
*/ private String applicationId; /** ** The unique identifier for the campaign that the activity applies to. *
*/ private String campaignId; /** ** The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED. *
*/ private String end; /** ** The unique identifier for the activity. *
*/ private String id; /** ** Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. *
*/ private String result; /** ** The scheduled start time, in ISO 8601 format, for the activity. *
*/ private String scheduledStart; /** ** The actual start time, in ISO 8601 format, of the activity. *
*/ private String start; /** ** The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and * COMPLETED. *
*/ private String state; /** ** The total number of endpoints that the campaign successfully delivered messages to. *
*/ private Integer successfulEndpointCount; /** ** The total number of time zones that were completed. *
*/ private Integer timezonesCompletedCount; /** ** The total number of unique time zones that are in the segment for the campaign. *
*/ private Integer timezonesTotalCount; /** ** The total number of endpoints that the campaign attempted to deliver messages to. *
*/ private 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. *
*/ private String treatmentId; /** ** A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. *
*/ private java.util.Map* The unique identifier for the application that the campaign applies to. *
* * @param applicationId * The unique identifier for the application that the campaign applies to. */ public void setApplicationId(String applicationId) { this.applicationId = applicationId; } /** ** The unique identifier for the application that the campaign applies to. *
* * @return The unique identifier for the application that the campaign applies to. */ public String getApplicationId() { return this.applicationId; } /** ** 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. */ public ActivityResponse withApplicationId(String applicationId) { setApplicationId(applicationId); return this; } /** ** The unique identifier for the campaign that the activity applies to. *
* * @param campaignId * The unique identifier for the campaign that the activity applies to. */ public void setCampaignId(String campaignId) { this.campaignId = campaignId; } /** ** The unique identifier for the campaign that the activity applies to. *
* * @return The unique identifier for the campaign that the activity applies to. */ public String getCampaignId() { return this.campaignId; } /** ** 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. */ public ActivityResponse withCampaignId(String campaignId) { setCampaignId(campaignId); return this; } /** ** 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. */ public void setEnd(String end) { this.end = end; } /** ** 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 String getEnd() { return this.end; } /** ** 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. */ public ActivityResponse withEnd(String end) { setEnd(end); return this; } /** ** The unique identifier for the activity. *
* * @param id * The unique identifier for the activity. */ public void setId(String id) { this.id = id; } /** ** The unique identifier for the activity. *
* * @return The unique identifier for the activity. */ public String getId() { return this.id; } /** ** 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. */ public ActivityResponse withId(String id) { setId(id); return this; } /** ** Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. *
* * @param result * Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. */ public void setResult(String result) { this.result = result; } /** ** Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. *
* * @return Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. */ public String getResult() { return this.result; } /** ** 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. */ public ActivityResponse withResult(String result) { setResult(result); return this; } /** ** The scheduled start time, in ISO 8601 format, for the activity. *
* * @param scheduledStart * The scheduled start time, in ISO 8601 format, for the activity. */ public void setScheduledStart(String scheduledStart) { this.scheduledStart = scheduledStart; } /** ** The scheduled start time, in ISO 8601 format, for the activity. *
* * @return The scheduled start time, in ISO 8601 format, for the activity. */ public String getScheduledStart() { return this.scheduledStart; } /** ** 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. */ public ActivityResponse withScheduledStart(String scheduledStart) { setScheduledStart(scheduledStart); return this; } /** ** The actual start time, in ISO 8601 format, of the activity. *
* * @param start * The actual start time, in ISO 8601 format, of the activity. */ public void setStart(String start) { this.start = start; } /** ** The actual start time, in ISO 8601 format, of the activity. *
* * @return The actual start time, in ISO 8601 format, of the activity. */ public String getStart() { return this.start; } /** ** 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. */ public ActivityResponse withStart(String start) { setStart(start); return this; } /** ** 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. */ public void setState(String state) { this.state = state; } /** ** 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 String getState() { return this.state; } /** ** 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. */ public ActivityResponse withState(String state) { setState(state); return this; } /** ** 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. */ public void setSuccessfulEndpointCount(Integer successfulEndpointCount) { this.successfulEndpointCount = successfulEndpointCount; } /** ** 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 Integer getSuccessfulEndpointCount() { return this.successfulEndpointCount; } /** ** 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. */ public ActivityResponse withSuccessfulEndpointCount(Integer successfulEndpointCount) { setSuccessfulEndpointCount(successfulEndpointCount); return this; } /** ** The total number of time zones that were completed. *
* * @param timezonesCompletedCount * The total number of time zones that were completed. */ public void setTimezonesCompletedCount(Integer timezonesCompletedCount) { this.timezonesCompletedCount = timezonesCompletedCount; } /** ** The total number of time zones that were completed. *
* * @return The total number of time zones that were completed. */ public Integer getTimezonesCompletedCount() { return this.timezonesCompletedCount; } /** ** 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. */ public ActivityResponse withTimezonesCompletedCount(Integer timezonesCompletedCount) { setTimezonesCompletedCount(timezonesCompletedCount); return this; } /** ** 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. */ public void setTimezonesTotalCount(Integer timezonesTotalCount) { this.timezonesTotalCount = timezonesTotalCount; } /** ** 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 Integer getTimezonesTotalCount() { return this.timezonesTotalCount; } /** ** 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. */ public ActivityResponse withTimezonesTotalCount(Integer timezonesTotalCount) { setTimezonesTotalCount(timezonesTotalCount); return this; } /** ** 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. */ public void setTotalEndpointCount(Integer totalEndpointCount) { this.totalEndpointCount = totalEndpointCount; } /** ** 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 Integer getTotalEndpointCount() { return this.totalEndpointCount; } /** ** 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. */ public ActivityResponse withTotalEndpointCount(Integer totalEndpointCount) { setTotalEndpointCount(totalEndpointCount); return this; } /** ** 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. */ public void setTreatmentId(String treatmentId) { this.treatmentId = 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 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 String getTreatmentId() { return this.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. *
* * @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. */ public ActivityResponse withTreatmentId(String treatmentId) { setTreatmentId(treatmentId); return this; } /** ** A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. *
* * @return A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. */ public java.util.Map* A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. *
* * @param executionMetrics * A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. */ public void setExecutionMetrics(java.util.Map* A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard * Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. *
* * @param executionMetrics * A JSON object that contains metrics relating to the campaign execution for this campaign activity. For * information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public ActivityResponse withExecutionMetrics(java.util.Map