com.amazonaws.services.ec2.model.DataQuery Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* A query used for retrieving network health data.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DataQuery implements Serializable, Cloneable {
/**
*
* A user-defined ID associated with a data query that's returned in the dataResponse identifying the
* query. For example, if you set the Id to MyQuery01in the query, the dataResponse
* identifies the query as MyQuery01.
*
*/
private String id;
/**
*
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
*
*/
private String source;
/**
*
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1.
*
*/
private String destination;
/**
*
* The metric, aggregation-latency, indicating that network latency is aggregated for the query. This
* is the only supported metric.
*
*/
private String metric;
/**
*
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data points
* gathered within those five minutes. p50 is the only supported metric.
*
*/
private String statistic;
/**
*
* The aggregation period used for the data query.
*
*/
private String period;
/**
*
* A user-defined ID associated with a data query that's returned in the dataResponse identifying the
* query. For example, if you set the Id to MyQuery01in the query, the dataResponse
* identifies the query as MyQuery01.
*
*
* @param id
* A user-defined ID associated with a data query that's returned in the dataResponse
* identifying the query. For example, if you set the Id to MyQuery01in the query, the
* dataResponse identifies the query as MyQuery01.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* A user-defined ID associated with a data query that's returned in the dataResponse identifying the
* query. For example, if you set the Id to MyQuery01in the query, the dataResponse
* identifies the query as MyQuery01.
*
*
* @return A user-defined ID associated with a data query that's returned in the dataResponse
* identifying the query. For example, if you set the Id to MyQuery01in the query, the
* dataResponse identifies the query as MyQuery01.
*/
public String getId() {
return this.id;
}
/**
*
* A user-defined ID associated with a data query that's returned in the dataResponse identifying the
* query. For example, if you set the Id to MyQuery01in the query, the dataResponse
* identifies the query as MyQuery01.
*
*
* @param id
* A user-defined ID associated with a data query that's returned in the dataResponse
* identifying the query. For example, if you set the Id to MyQuery01in the query, the
* dataResponse identifies the query as MyQuery01.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQuery withId(String id) {
setId(id);
return this;
}
/**
*
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
*
*
* @param source
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
*/
public void setSource(String source) {
this.source = source;
}
/**
*
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
*
*
* @return The Region or Availability Zone that's the source for the data query. For example, us-east-1
* .
*/
public String getSource() {
return this.source;
}
/**
*
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
*
*
* @param source
* The Region or Availability Zone that's the source for the data query. For example, us-east-1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQuery withSource(String source) {
setSource(source);
return this;
}
/**
*
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1.
*
*
* @param destination
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1
* .
*/
public void setDestination(String destination) {
this.destination = destination;
}
/**
*
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1.
*
*
* @return The Region or Availability Zone that's the target for the data query. For example,
* eu-north-1.
*/
public String getDestination() {
return this.destination;
}
/**
*
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1.
*
*
* @param destination
* The Region or Availability Zone that's the target for the data query. For example, eu-north-1
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataQuery withDestination(String destination) {
setDestination(destination);
return this;
}
/**
*
* The metric, aggregation-latency, indicating that network latency is aggregated for the query. This
* is the only supported metric.
*
*
* @param metric
* The metric, aggregation-latency, indicating that network latency is aggregated for the query.
* This is the only supported metric.
* @see MetricType
*/
public void setMetric(String metric) {
this.metric = metric;
}
/**
*
* The metric, aggregation-latency, indicating that network latency is aggregated for the query. This
* is the only supported metric.
*
*
* @return The metric, aggregation-latency, indicating that network latency is aggregated for the
* query. This is the only supported metric.
* @see MetricType
*/
public String getMetric() {
return this.metric;
}
/**
*
* The metric, aggregation-latency, indicating that network latency is aggregated for the query. This
* is the only supported metric.
*
*
* @param metric
* The metric, aggregation-latency, indicating that network latency is aggregated for the query.
* This is the only supported metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
public DataQuery withMetric(String metric) {
setMetric(metric);
return this;
}
/**
*
* The metric, aggregation-latency, indicating that network latency is aggregated for the query. This
* is the only supported metric.
*
*
* @param metric
* The metric, aggregation-latency, indicating that network latency is aggregated for the query.
* This is the only supported metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricType
*/
public DataQuery withMetric(MetricType metric) {
this.metric = metric.toString();
return this;
}
/**
*
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data points
* gathered within those five minutes. p50 is the only supported metric.
*
*
* @param statistic
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data
* points gathered within those five minutes. p50 is the only supported metric.
* @see StatisticType
*/
public void setStatistic(String statistic) {
this.statistic = statistic;
}
/**
*
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data points
* gathered within those five minutes. p50 is the only supported metric.
*
*
* @return The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data
* points gathered within those five minutes. p50 is the only supported metric.
* @see StatisticType
*/
public String getStatistic() {
return this.statistic;
}
/**
*
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data points
* gathered within those five minutes. p50 is the only supported metric.
*
*
* @param statistic
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data
* points gathered within those five minutes. p50 is the only supported metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatisticType
*/
public DataQuery withStatistic(String statistic) {
setStatistic(statistic);
return this;
}
/**
*
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data points
* gathered within those five minutes. p50 is the only supported metric.
*
*
* @param statistic
* The metric data aggregation period, p50, between the specified startDate and
* endDate. For example, a metric of five_minutes is the median of all the data
* points gathered within those five minutes. p50 is the only supported metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatisticType
*/
public DataQuery withStatistic(StatisticType statistic) {
this.statistic = statistic.toString();
return this;
}
/**
*
* The aggregation period used for the data query.
*
*
* @param period
* The aggregation period used for the data query.
* @see PeriodType
*/
public void setPeriod(String period) {
this.period = period;
}
/**
*
* The aggregation period used for the data query.
*
*
* @return The aggregation period used for the data query.
* @see PeriodType
*/
public String getPeriod() {
return this.period;
}
/**
*
* The aggregation period used for the data query.
*
*
* @param period
* The aggregation period used for the data query.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeriodType
*/
public DataQuery withPeriod(String period) {
setPeriod(period);
return this;
}
/**
*
* The aggregation period used for the data query.
*
*
* @param period
* The aggregation period used for the data query.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PeriodType
*/
public DataQuery withPeriod(PeriodType period) {
this.period = period.toString();
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getMetric() != null)
sb.append("Metric: ").append(getMetric()).append(",");
if (getStatistic() != null)
sb.append("Statistic: ").append(getStatistic()).append(",");
if (getPeriod() != null)
sb.append("Period: ").append(getPeriod());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DataQuery == false)
return false;
DataQuery other = (DataQuery) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getMetric() == null ^ this.getMetric() == null)
return false;
if (other.getMetric() != null && other.getMetric().equals(this.getMetric()) == false)
return false;
if (other.getStatistic() == null ^ this.getStatistic() == null)
return false;
if (other.getStatistic() != null && other.getStatistic().equals(this.getStatistic()) == false)
return false;
if (other.getPeriod() == null ^ this.getPeriod() == null)
return false;
if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getMetric() == null) ? 0 : getMetric().hashCode());
hashCode = prime * hashCode + ((getStatistic() == null) ? 0 : getStatistic().hashCode());
hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode());
return hashCode;
}
@Override
public DataQuery clone() {
try {
return (DataQuery) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}