/* * 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 the results of a query that retrieved the data for a standard execution metric that applies to a journey, * and provides information about that query. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class JourneyExecutionMetricsResponse implements Serializable, Cloneable, StructuredPojo { /** *

* The unique identifier for the application that the metric applies to. *

*/ private String applicationId; /** *

* The unique identifier for the journey that the metric applies to. *

*/ private String journeyId; /** *

* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for * the metric. *

*/ private String lastEvaluatedTime; /** *

* A JSON object that contains the results of the query. For information about the structure and contents of the * results, see the Amazon * Pinpoint Developer Guide. *

*/ private java.util.Map metrics; /** *

* The unique identifier for the application that the metric applies to. *

* * @param applicationId * The unique identifier for the application that the metric applies to. */ public void setApplicationId(String applicationId) { this.applicationId = applicationId; } /** *

* The unique identifier for the application that the metric applies to. *

* * @return The unique identifier for the application that the metric applies to. */ public String getApplicationId() { return this.applicationId; } /** *

* The unique identifier for the application that the metric applies to. *

* * @param applicationId * The unique identifier for the application that the metric applies to. * @return Returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse withApplicationId(String applicationId) { setApplicationId(applicationId); return this; } /** *

* The unique identifier for the journey that the metric applies to. *

* * @param journeyId * The unique identifier for the journey that the metric applies to. */ public void setJourneyId(String journeyId) { this.journeyId = journeyId; } /** *

* The unique identifier for the journey that the metric applies to. *

* * @return The unique identifier for the journey that the metric applies to. */ public String getJourneyId() { return this.journeyId; } /** *

* The unique identifier for the journey that the metric applies to. *

* * @param journeyId * The unique identifier for the journey that the metric applies to. * @return Returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse withJourneyId(String journeyId) { setJourneyId(journeyId); return this; } /** *

* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for * the metric. *

* * @param lastEvaluatedTime * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the * data for the metric. */ public void setLastEvaluatedTime(String lastEvaluatedTime) { this.lastEvaluatedTime = lastEvaluatedTime; } /** *

* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for * the metric. *

* * @return The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the * data for the metric. */ public String getLastEvaluatedTime() { return this.lastEvaluatedTime; } /** *

* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for * the metric. *

* * @param lastEvaluatedTime * The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the * data for the metric. * @return Returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse withLastEvaluatedTime(String lastEvaluatedTime) { setLastEvaluatedTime(lastEvaluatedTime); return this; } /** *

* A JSON object that contains the results of the query. For information about the structure and contents of the * results, see the Amazon * Pinpoint Developer Guide. *

* * @return A JSON object that contains the results of the query. For information about the structure and contents of * the results, see the Amazon * Pinpoint Developer Guide. */ public java.util.Map getMetrics() { return metrics; } /** *

* A JSON object that contains the results of the query. For information about the structure and contents of the * results, see the Amazon * Pinpoint Developer Guide. *

* * @param metrics * A JSON object that contains the results of the query. For information about the structure and contents of * the results, see the Amazon * Pinpoint Developer Guide. */ public void setMetrics(java.util.Map metrics) { this.metrics = metrics; } /** *

* A JSON object that contains the results of the query. For information about the structure and contents of the * results, see the Amazon * Pinpoint Developer Guide. *

* * @param metrics * A JSON object that contains the results of the query. For information about the structure and contents of * the results, see the Amazon * Pinpoint Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse withMetrics(java.util.Map metrics) { setMetrics(metrics); return this; } /** * Add a single Metrics entry * * @see JourneyExecutionMetricsResponse#withMetrics * @returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse addMetricsEntry(String key, String value) { if (null == this.metrics) { this.metrics = new java.util.HashMap(); } if (this.metrics.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.metrics.put(key, value); return this; } /** * Removes all the entries added into Metrics. * * @return Returns a reference to this object so that method calls can be chained together. */ public JourneyExecutionMetricsResponse clearMetricsEntries() { this.metrics = null; return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getApplicationId() != null) sb.append("ApplicationId: ").append(getApplicationId()).append(","); if (getJourneyId() != null) sb.append("JourneyId: ").append(getJourneyId()).append(","); if (getLastEvaluatedTime() != null) sb.append("LastEvaluatedTime: ").append(getLastEvaluatedTime()).append(","); if (getMetrics() != null) sb.append("Metrics: ").append(getMetrics()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof JourneyExecutionMetricsResponse == false) return false; JourneyExecutionMetricsResponse other = (JourneyExecutionMetricsResponse) obj; if (other.getApplicationId() == null ^ this.getApplicationId() == null) return false; if (other.getApplicationId() != null && other.getApplicationId().equals(this.getApplicationId()) == false) return false; if (other.getJourneyId() == null ^ this.getJourneyId() == null) return false; if (other.getJourneyId() != null && other.getJourneyId().equals(this.getJourneyId()) == false) return false; if (other.getLastEvaluatedTime() == null ^ this.getLastEvaluatedTime() == null) return false; if (other.getLastEvaluatedTime() != null && other.getLastEvaluatedTime().equals(this.getLastEvaluatedTime()) == false) return false; if (other.getMetrics() == null ^ this.getMetrics() == null) return false; if (other.getMetrics() != null && other.getMetrics().equals(this.getMetrics()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getApplicationId() == null) ? 0 : getApplicationId().hashCode()); hashCode = prime * hashCode + ((getJourneyId() == null) ? 0 : getJourneyId().hashCode()); hashCode = prime * hashCode + ((getLastEvaluatedTime() == null) ? 0 : getLastEvaluatedTime().hashCode()); hashCode = prime * hashCode + ((getMetrics() == null) ? 0 : getMetrics().hashCode()); return hashCode; } @Override public JourneyExecutionMetricsResponse clone() { try { return (JourneyExecutionMetricsResponse) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.pinpoint.model.transform.JourneyExecutionMetricsResponseMarshaller.getInstance().marshall(this, protocolMarshaller); } }