All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.cloudwatch.model.GetMetricStreamResult Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon CloudWatch module holds the client classes that are used for communicating with Amazon CloudWatch Service

There is a newer version: 1.12.778
Show newest version
/*
 * 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.cloudwatch.model;

import java.io.Serializable;
import javax.annotation.Generated;

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

    /**
     * 

* The ARN of the metric stream. *

*/ private String arn; /** *

* The name of the metric stream. *

*/ private String name; /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are * streamed by this metric stream. *

*/ private com.amazonaws.internal.SdkInternalList includeFilters; /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not * streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this * metric stream. *

*/ private com.amazonaws.internal.SdkInternalList excludeFilters; /** *

* The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. *

*/ private String firehoseArn; /** *

* The ARN of the IAM role that is used by this metric stream. *

*/ private String roleArn; /** *

* The state of the metric stream. The possible values are running and stopped. *

*/ private String state; /** *

* The date that the metric stream was created. *

*/ private java.util.Date creationDate; /** *

* The date of the most recent update to the metric stream's configuration. *

*/ private java.util.Date lastUpdateDate; /** *

* The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. *

*/ private String outputFormat; /** *

* Each entry in this array displays information about one or more metrics that include additional statistics in the * metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. *

*/ private com.amazonaws.internal.SdkInternalList statisticsConfigurations; /** *

* If this is true and this metric stream is in a monitoring account, then the stream includes metrics * from source accounts that the monitoring account is linked to. *

*/ private Boolean includeLinkedAccountsMetrics; /** *

* The ARN of the metric stream. *

* * @param arn * The ARN of the metric stream. */ public void setArn(String arn) { this.arn = arn; } /** *

* The ARN of the metric stream. *

* * @return The ARN of the metric stream. */ public String getArn() { return this.arn; } /** *

* The ARN of the metric stream. *

* * @param arn * The ARN of the metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withArn(String arn) { setArn(arn); return this; } /** *

* The name of the metric stream. *

* * @param name * The name of the metric stream. */ public void setName(String name) { this.name = name; } /** *

* The name of the metric stream. *

* * @return The name of the metric stream. */ public String getName() { return this.name; } /** *

* The name of the metric stream. *

* * @param name * The name of the metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withName(String name) { setName(name); return this; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are * streamed by this metric stream. *

* * @return If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are streamed by this metric stream. */ public java.util.List getIncludeFilters() { if (includeFilters == null) { includeFilters = new com.amazonaws.internal.SdkInternalList(); } return includeFilters; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are * streamed by this metric stream. *

* * @param includeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are streamed by this metric stream. */ public void setIncludeFilters(java.util.Collection includeFilters) { if (includeFilters == null) { this.includeFilters = null; return; } this.includeFilters = new com.amazonaws.internal.SdkInternalList(includeFilters); } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are * streamed by this metric stream. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setIncludeFilters(java.util.Collection)} or {@link #withIncludeFilters(java.util.Collection)} if you want * to override the existing values. *

* * @param includeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are streamed by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withIncludeFilters(MetricStreamFilter... includeFilters) { if (this.includeFilters == null) { setIncludeFilters(new com.amazonaws.internal.SdkInternalList(includeFilters.length)); } for (MetricStreamFilter ele : includeFilters) { this.includeFilters.add(ele); } return this; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are * streamed by this metric stream. *

* * @param includeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are streamed by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withIncludeFilters(java.util.Collection includeFilters) { setIncludeFilters(includeFilters); return this; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not * streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this * metric stream. *

* * @return If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are not streamed by this metric stream. In this case, all other metric namespaces in the account are * streamed by this metric stream. */ public java.util.List getExcludeFilters() { if (excludeFilters == null) { excludeFilters = new com.amazonaws.internal.SdkInternalList(); } return excludeFilters; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not * streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this * metric stream. *

* * @param excludeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are not streamed by this metric stream. In this case, all other metric namespaces in the account are * streamed by this metric stream. */ public void setExcludeFilters(java.util.Collection excludeFilters) { if (excludeFilters == null) { this.excludeFilters = null; return; } this.excludeFilters = new com.amazonaws.internal.SdkInternalList(excludeFilters); } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not * streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this * metric stream. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setExcludeFilters(java.util.Collection)} or {@link #withExcludeFilters(java.util.Collection)} if you want * to override the existing values. *

* * @param excludeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are not streamed by this metric stream. In this case, all other metric namespaces in the account are * streamed by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withExcludeFilters(MetricStreamFilter... excludeFilters) { if (this.excludeFilters == null) { setExcludeFilters(new com.amazonaws.internal.SdkInternalList(excludeFilters.length)); } for (MetricStreamFilter ele : excludeFilters) { this.excludeFilters.add(ele); } return this; } /** *

* If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not * streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this * metric stream. *

* * @param excludeFilters * If this array of metric namespaces is present, then these namespaces are the only metric namespaces that * are not streamed by this metric stream. In this case, all other metric namespaces in the account are * streamed by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withExcludeFilters(java.util.Collection excludeFilters) { setExcludeFilters(excludeFilters); return this; } /** *

* The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. *

* * @param firehoseArn * The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. */ public void setFirehoseArn(String firehoseArn) { this.firehoseArn = firehoseArn; } /** *

* The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. *

* * @return The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. */ public String getFirehoseArn() { return this.firehoseArn; } /** *

* The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. *

* * @param firehoseArn * The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withFirehoseArn(String firehoseArn) { setFirehoseArn(firehoseArn); return this; } /** *

* The ARN of the IAM role that is used by this metric stream. *

* * @param roleArn * The ARN of the IAM role that is used by this metric stream. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** *

* The ARN of the IAM role that is used by this metric stream. *

* * @return The ARN of the IAM role that is used by this metric stream. */ public String getRoleArn() { return this.roleArn; } /** *

* The ARN of the IAM role that is used by this metric stream. *

* * @param roleArn * The ARN of the IAM role that is used by this metric stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** *

* The state of the metric stream. The possible values are running and stopped. *

* * @param state * The state of the metric stream. The possible values are running and stopped. */ public void setState(String state) { this.state = state; } /** *

* The state of the metric stream. The possible values are running and stopped. *

* * @return The state of the metric stream. The possible values are running and stopped. */ public String getState() { return this.state; } /** *

* The state of the metric stream. The possible values are running and stopped. *

* * @param state * The state of the metric stream. The possible values are running and stopped. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withState(String state) { setState(state); return this; } /** *

* The date that the metric stream was created. *

* * @param creationDate * The date that the metric stream was created. */ public void setCreationDate(java.util.Date creationDate) { this.creationDate = creationDate; } /** *

* The date that the metric stream was created. *

* * @return The date that the metric stream was created. */ public java.util.Date getCreationDate() { return this.creationDate; } /** *

* The date that the metric stream was created. *

* * @param creationDate * The date that the metric stream was created. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withCreationDate(java.util.Date creationDate) { setCreationDate(creationDate); return this; } /** *

* The date of the most recent update to the metric stream's configuration. *

* * @param lastUpdateDate * The date of the most recent update to the metric stream's configuration. */ public void setLastUpdateDate(java.util.Date lastUpdateDate) { this.lastUpdateDate = lastUpdateDate; } /** *

* The date of the most recent update to the metric stream's configuration. *

* * @return The date of the most recent update to the metric stream's configuration. */ public java.util.Date getLastUpdateDate() { return this.lastUpdateDate; } /** *

* The date of the most recent update to the metric stream's configuration. *

* * @param lastUpdateDate * The date of the most recent update to the metric stream's configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withLastUpdateDate(java.util.Date lastUpdateDate) { setLastUpdateDate(lastUpdateDate); return this; } /** *

* The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. *

* * @param outputFormat * The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. * @see MetricStreamOutputFormat */ public void setOutputFormat(String outputFormat) { this.outputFormat = outputFormat; } /** *

* The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. *

* * @return The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. * @see MetricStreamOutputFormat */ public String getOutputFormat() { return this.outputFormat; } /** *

* The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. *

* * @param outputFormat * The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. * @return Returns a reference to this object so that method calls can be chained together. * @see MetricStreamOutputFormat */ public GetMetricStreamResult withOutputFormat(String outputFormat) { setOutputFormat(outputFormat); return this; } /** *

* The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. *

* * @param outputFormat * The output format for the stream. Valid values are json, opentelemetry1.0, and * opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats. * @return Returns a reference to this object so that method calls can be chained together. * @see MetricStreamOutputFormat */ public GetMetricStreamResult withOutputFormat(MetricStreamOutputFormat outputFormat) { this.outputFormat = outputFormat.toString(); return this; } /** *

* Each entry in this array displays information about one or more metrics that include additional statistics in the * metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. *

* * @return Each entry in this array displays information about one or more metrics that include additional * statistics in the metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. */ public java.util.List getStatisticsConfigurations() { if (statisticsConfigurations == null) { statisticsConfigurations = new com.amazonaws.internal.SdkInternalList(); } return statisticsConfigurations; } /** *

* Each entry in this array displays information about one or more metrics that include additional statistics in the * metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. *

* * @param statisticsConfigurations * Each entry in this array displays information about one or more metrics that include additional statistics * in the metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. */ public void setStatisticsConfigurations(java.util.Collection statisticsConfigurations) { if (statisticsConfigurations == null) { this.statisticsConfigurations = null; return; } this.statisticsConfigurations = new com.amazonaws.internal.SdkInternalList(statisticsConfigurations); } /** *

* Each entry in this array displays information about one or more metrics that include additional statistics in the * metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setStatisticsConfigurations(java.util.Collection)} or * {@link #withStatisticsConfigurations(java.util.Collection)} if you want to override the existing values. *

* * @param statisticsConfigurations * Each entry in this array displays information about one or more metrics that include additional statistics * in the metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withStatisticsConfigurations(MetricStreamStatisticsConfiguration... statisticsConfigurations) { if (this.statisticsConfigurations == null) { setStatisticsConfigurations(new com.amazonaws.internal.SdkInternalList(statisticsConfigurations.length)); } for (MetricStreamStatisticsConfiguration ele : statisticsConfigurations) { this.statisticsConfigurations.add(ele); } return this; } /** *

* Each entry in this array displays information about one or more metrics that include additional statistics in the * metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. *

* * @param statisticsConfigurations * Each entry in this array displays information about one or more metrics that include additional statistics * in the metric stream. For more information about the additional statistics, see * CloudWatch statistics definitions. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withStatisticsConfigurations(java.util.Collection statisticsConfigurations) { setStatisticsConfigurations(statisticsConfigurations); return this; } /** *

* If this is true and this metric stream is in a monitoring account, then the stream includes metrics * from source accounts that the monitoring account is linked to. *

* * @param includeLinkedAccountsMetrics * If this is true and this metric stream is in a monitoring account, then the stream includes * metrics from source accounts that the monitoring account is linked to. */ public void setIncludeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics) { this.includeLinkedAccountsMetrics = includeLinkedAccountsMetrics; } /** *

* If this is true and this metric stream is in a monitoring account, then the stream includes metrics * from source accounts that the monitoring account is linked to. *

* * @return If this is true and this metric stream is in a monitoring account, then the stream includes * metrics from source accounts that the monitoring account is linked to. */ public Boolean getIncludeLinkedAccountsMetrics() { return this.includeLinkedAccountsMetrics; } /** *

* If this is true and this metric stream is in a monitoring account, then the stream includes metrics * from source accounts that the monitoring account is linked to. *

* * @param includeLinkedAccountsMetrics * If this is true and this metric stream is in a monitoring account, then the stream includes * metrics from source accounts that the monitoring account is linked to. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricStreamResult withIncludeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics) { setIncludeLinkedAccountsMetrics(includeLinkedAccountsMetrics); return this; } /** *

* If this is true and this metric stream is in a monitoring account, then the stream includes metrics * from source accounts that the monitoring account is linked to. *

* * @return If this is true and this metric stream is in a monitoring account, then the stream includes * metrics from source accounts that the monitoring account is linked to. */ public Boolean isIncludeLinkedAccountsMetrics() { return this.includeLinkedAccountsMetrics; } /** * 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 (getArn() != null) sb.append("Arn: ").append(getArn()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getIncludeFilters() != null) sb.append("IncludeFilters: ").append(getIncludeFilters()).append(","); if (getExcludeFilters() != null) sb.append("ExcludeFilters: ").append(getExcludeFilters()).append(","); if (getFirehoseArn() != null) sb.append("FirehoseArn: ").append(getFirehoseArn()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getState() != null) sb.append("State: ").append(getState()).append(","); if (getCreationDate() != null) sb.append("CreationDate: ").append(getCreationDate()).append(","); if (getLastUpdateDate() != null) sb.append("LastUpdateDate: ").append(getLastUpdateDate()).append(","); if (getOutputFormat() != null) sb.append("OutputFormat: ").append(getOutputFormat()).append(","); if (getStatisticsConfigurations() != null) sb.append("StatisticsConfigurations: ").append(getStatisticsConfigurations()).append(","); if (getIncludeLinkedAccountsMetrics() != null) sb.append("IncludeLinkedAccountsMetrics: ").append(getIncludeLinkedAccountsMetrics()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetMetricStreamResult == false) return false; GetMetricStreamResult other = (GetMetricStreamResult) obj; if (other.getArn() == null ^ this.getArn() == null) return false; if (other.getArn() != null && other.getArn().equals(this.getArn()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getIncludeFilters() == null ^ this.getIncludeFilters() == null) return false; if (other.getIncludeFilters() != null && other.getIncludeFilters().equals(this.getIncludeFilters()) == false) return false; if (other.getExcludeFilters() == null ^ this.getExcludeFilters() == null) return false; if (other.getExcludeFilters() != null && other.getExcludeFilters().equals(this.getExcludeFilters()) == false) return false; if (other.getFirehoseArn() == null ^ this.getFirehoseArn() == null) return false; if (other.getFirehoseArn() != null && other.getFirehoseArn().equals(this.getFirehoseArn()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getState() == null ^ this.getState() == null) return false; if (other.getState() != null && other.getState().equals(this.getState()) == false) return false; if (other.getCreationDate() == null ^ this.getCreationDate() == null) return false; if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false) return false; if (other.getLastUpdateDate() == null ^ this.getLastUpdateDate() == null) return false; if (other.getLastUpdateDate() != null && other.getLastUpdateDate().equals(this.getLastUpdateDate()) == false) return false; if (other.getOutputFormat() == null ^ this.getOutputFormat() == null) return false; if (other.getOutputFormat() != null && other.getOutputFormat().equals(this.getOutputFormat()) == false) return false; if (other.getStatisticsConfigurations() == null ^ this.getStatisticsConfigurations() == null) return false; if (other.getStatisticsConfigurations() != null && other.getStatisticsConfigurations().equals(this.getStatisticsConfigurations()) == false) return false; if (other.getIncludeLinkedAccountsMetrics() == null ^ this.getIncludeLinkedAccountsMetrics() == null) return false; if (other.getIncludeLinkedAccountsMetrics() != null && other.getIncludeLinkedAccountsMetrics().equals(this.getIncludeLinkedAccountsMetrics()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getIncludeFilters() == null) ? 0 : getIncludeFilters().hashCode()); hashCode = prime * hashCode + ((getExcludeFilters() == null) ? 0 : getExcludeFilters().hashCode()); hashCode = prime * hashCode + ((getFirehoseArn() == null) ? 0 : getFirehoseArn().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode()); hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode()); hashCode = prime * hashCode + ((getLastUpdateDate() == null) ? 0 : getLastUpdateDate().hashCode()); hashCode = prime * hashCode + ((getOutputFormat() == null) ? 0 : getOutputFormat().hashCode()); hashCode = prime * hashCode + ((getStatisticsConfigurations() == null) ? 0 : getStatisticsConfigurations().hashCode()); hashCode = prime * hashCode + ((getIncludeLinkedAccountsMetrics() == null) ? 0 : getIncludeLinkedAccountsMetrics().hashCode()); return hashCode; } @Override public GetMetricStreamResult clone() { try { return (GetMetricStreamResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy