com.amazonaws.services.cloudwatchrum.model.BatchCreateRumMetricDefinitionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatchrum 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.cloudwatchrum.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchCreateRumMetricDefinitionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the CloudWatch RUM app monitor that is to send the metrics.
*
*/
private String appMonitorName;
/**
*
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
* you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
* CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
* experiment.
*
*/
private String destination;
/**
*
* This parameter is required if Destination is Evidently. If Destination is
* CloudWatch, do not use this parameter.
*
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*
*/
private String destinationArn;
/**
*
* An array of structures which define the metrics that you want to send.
*
*/
private java.util.List metricDefinitions;
/**
*
* The name of the CloudWatch RUM app monitor that is to send the metrics.
*
*
* @param appMonitorName
* The name of the CloudWatch RUM app monitor that is to send the metrics.
*/
public void setAppMonitorName(String appMonitorName) {
this.appMonitorName = appMonitorName;
}
/**
*
* The name of the CloudWatch RUM app monitor that is to send the metrics.
*
*
* @return The name of the CloudWatch RUM app monitor that is to send the metrics.
*/
public String getAppMonitorName() {
return this.appMonitorName;
}
/**
*
* The name of the CloudWatch RUM app monitor that is to send the metrics.
*
*
* @param appMonitorName
* The name of the CloudWatch RUM app monitor that is to send the metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchCreateRumMetricDefinitionsRequest withAppMonitorName(String appMonitorName) {
setAppMonitorName(appMonitorName);
return this;
}
/**
*
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
* you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
* CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
* experiment.
*
*
* @param destination
* The destination to send the metrics to. Valid values are CloudWatch and
* Evidently. If you specify Evidently, you must also specify the Amazon Resource
* Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has
* permission to write to the experiment.
* @see MetricDestination
*/
public void setDestination(String destination) {
this.destination = destination;
}
/**
*
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
* you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
* CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
* experiment.
*
*
* @return The destination to send the metrics to. Valid values are CloudWatch and
* Evidently. If you specify Evidently, you must also specify the Amazon Resource
* Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has
* permission to write to the experiment.
* @see MetricDestination
*/
public String getDestination() {
return this.destination;
}
/**
*
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
* you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
* CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
* experiment.
*
*
* @param destination
* The destination to send the metrics to. Valid values are CloudWatch and
* Evidently. If you specify Evidently, you must also specify the Amazon Resource
* Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has
* permission to write to the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricDestination
*/
public BatchCreateRumMetricDefinitionsRequest withDestination(String destination) {
setDestination(destination);
return this;
}
/**
*
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If
* you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the
* CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the
* experiment.
*
*
* @param destination
* The destination to send the metrics to. Valid values are CloudWatch and
* Evidently. If you specify Evidently, you must also specify the Amazon Resource
* Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has
* permission to write to the experiment.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricDestination
*/
public BatchCreateRumMetricDefinitionsRequest withDestination(MetricDestination destination) {
this.destination = destination.toString();
return this;
}
/**
*
* This parameter is required if Destination is Evidently. If Destination is
* CloudWatch, do not use this parameter.
*
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*
*
* @param destinationArn
* This parameter is required if Destination is Evidently. If
* Destination is CloudWatch, do not use this parameter.
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*/
public void setDestinationArn(String destinationArn) {
this.destinationArn = destinationArn;
}
/**
*
* This parameter is required if Destination is Evidently. If Destination is
* CloudWatch, do not use this parameter.
*
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*
*
* @return This parameter is required if Destination is Evidently. If
* Destination is CloudWatch, do not use this parameter.
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must
* have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*/
public String getDestinationArn() {
return this.destinationArn;
}
/**
*
* This parameter is required if Destination is Evidently. If Destination is
* CloudWatch, do not use this parameter.
*
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
*
*
* @param destinationArn
* This parameter is required if Destination is Evidently. If
* Destination is CloudWatch, do not use this parameter.
*
* This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have
* already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchCreateRumMetricDefinitionsRequest withDestinationArn(String destinationArn) {
setDestinationArn(destinationArn);
return this;
}
/**
*
* An array of structures which define the metrics that you want to send.
*
*
* @return An array of structures which define the metrics that you want to send.
*/
public java.util.List getMetricDefinitions() {
return metricDefinitions;
}
/**
*
* An array of structures which define the metrics that you want to send.
*
*
* @param metricDefinitions
* An array of structures which define the metrics that you want to send.
*/
public void setMetricDefinitions(java.util.Collection metricDefinitions) {
if (metricDefinitions == null) {
this.metricDefinitions = null;
return;
}
this.metricDefinitions = new java.util.ArrayList(metricDefinitions);
}
/**
*
* An array of structures which define the metrics that you want to send.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMetricDefinitions(java.util.Collection)} or {@link #withMetricDefinitions(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param metricDefinitions
* An array of structures which define the metrics that you want to send.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchCreateRumMetricDefinitionsRequest withMetricDefinitions(MetricDefinitionRequest... metricDefinitions) {
if (this.metricDefinitions == null) {
setMetricDefinitions(new java.util.ArrayList(metricDefinitions.length));
}
for (MetricDefinitionRequest ele : metricDefinitions) {
this.metricDefinitions.add(ele);
}
return this;
}
/**
*
* An array of structures which define the metrics that you want to send.
*
*
* @param metricDefinitions
* An array of structures which define the metrics that you want to send.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchCreateRumMetricDefinitionsRequest withMetricDefinitions(java.util.Collection metricDefinitions) {
setMetricDefinitions(metricDefinitions);
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 (getAppMonitorName() != null)
sb.append("AppMonitorName: ").append(getAppMonitorName()).append(",");
if (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getDestinationArn() != null)
sb.append("DestinationArn: ").append(getDestinationArn()).append(",");
if (getMetricDefinitions() != null)
sb.append("MetricDefinitions: ").append(getMetricDefinitions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchCreateRumMetricDefinitionsRequest == false)
return false;
BatchCreateRumMetricDefinitionsRequest other = (BatchCreateRumMetricDefinitionsRequest) obj;
if (other.getAppMonitorName() == null ^ this.getAppMonitorName() == null)
return false;
if (other.getAppMonitorName() != null && other.getAppMonitorName().equals(this.getAppMonitorName()) == 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.getDestinationArn() == null ^ this.getDestinationArn() == null)
return false;
if (other.getDestinationArn() != null && other.getDestinationArn().equals(this.getDestinationArn()) == false)
return false;
if (other.getMetricDefinitions() == null ^ this.getMetricDefinitions() == null)
return false;
if (other.getMetricDefinitions() != null && other.getMetricDefinitions().equals(this.getMetricDefinitions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAppMonitorName() == null) ? 0 : getAppMonitorName().hashCode());
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getDestinationArn() == null) ? 0 : getDestinationArn().hashCode());
hashCode = prime * hashCode + ((getMetricDefinitions() == null) ? 0 : getMetricDefinitions().hashCode());
return hashCode;
}
@Override
public BatchCreateRumMetricDefinitionsRequest clone() {
return (BatchCreateRumMetricDefinitionsRequest) super.clone();
}
}