GetMetricStreamResult (AWS Java SDK for Amazon CloudWatch 1.12.552 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cloudwatch.model.GetMetricStreamResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetMetricStreamResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetMetricStreamResult()

Constructors
Constructor and Description
`GetMetricStreamResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetMetricStreamResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The ARN of the metric stream.
`Date`	`getCreationDate()` The date that the metric stream was created.
`List<MetricStreamFilter>`	`getExcludeFilters()` If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream.
`String`	`getFirehoseArn()` The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
`List<MetricStreamFilter>`	`getIncludeFilters()` If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
`Boolean`	`getIncludeLinkedAccountsMetrics()` 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.
`Date`	`getLastUpdateDate()` The date of the most recent update to the metric stream's configuration.
`String`	`getName()` The name of the metric stream.
`String`	`getOutputFormat()` The output format for the stream.
`String`	`getRoleArn()` The ARN of the IAM role that is used by this metric stream.
`String`	`getState()` The state of the metric stream.
`List<MetricStreamStatisticsConfiguration>`	`getStatisticsConfigurations()` Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.
`int`	`hashCode()`
`Boolean`	`isIncludeLinkedAccountsMetrics()` 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.
`void`	`setArn(String arn)` The ARN of the metric stream.
`void`	`setCreationDate(Date creationDate)` The date that the metric stream was created.
`void`	`setExcludeFilters(Collection<MetricStreamFilter> 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.
`void`	`setFirehoseArn(String firehoseArn)` The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
`void`	`setIncludeFilters(Collection<MetricStreamFilter> includeFilters)` If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
`void`	`setIncludeLinkedAccountsMetrics(Boolean 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.
`void`	`setLastUpdateDate(Date lastUpdateDate)` The date of the most recent update to the metric stream's configuration.
`void`	`setName(String name)` The name of the metric stream.
`void`	`setOutputFormat(String outputFormat)` The output format for the stream.
`void`	`setRoleArn(String roleArn)` The ARN of the IAM role that is used by this metric stream.
`void`	`setState(String state)` The state of the metric stream.
`void`	`setStatisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> statisticsConfigurations)` Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.
`String`	`toString()` Returns a string representation of this object.
`GetMetricStreamResult`	`withArn(String arn)` The ARN of the metric stream.
`GetMetricStreamResult`	`withCreationDate(Date creationDate)` The date that the metric stream was created.
`GetMetricStreamResult`	`withExcludeFilters(Collection<MetricStreamFilter> 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.
`GetMetricStreamResult`	`withExcludeFilters(MetricStreamFilter... 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.
`GetMetricStreamResult`	`withFirehoseArn(String firehoseArn)` The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
`GetMetricStreamResult`	`withIncludeFilters(Collection<MetricStreamFilter> includeFilters)` If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
`GetMetricStreamResult`	`withIncludeFilters(MetricStreamFilter... includeFilters)` If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
`GetMetricStreamResult`	`withIncludeLinkedAccountsMetrics(Boolean 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.
`GetMetricStreamResult`	`withLastUpdateDate(Date lastUpdateDate)` The date of the most recent update to the metric stream's configuration.
`GetMetricStreamResult`	`withName(String name)` The name of the metric stream.
`GetMetricStreamResult`	`withOutputFormat(MetricStreamOutputFormat outputFormat)` The output format for the stream.
`GetMetricStreamResult`	`withOutputFormat(String outputFormat)` The output format for the stream.
`GetMetricStreamResult`	`withRoleArn(String roleArn)` The ARN of the IAM role that is used by this metric stream.
`GetMetricStreamResult`	`withState(String state)` The state of the metric stream.
`GetMetricStreamResult`	`withStatisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> statisticsConfigurations)` Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.
`GetMetricStreamResult`	`withStatisticsConfigurations(MetricStreamStatisticsConfiguration... statisticsConfigurations)` Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetMetricStreamResult
```
public GetMetricStreamResult()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The ARN of the metric stream.
    
    Parameters:
    
    arn - The ARN of the metric stream.
  - getArn
```
public String getArn()
```
    The ARN of the metric stream.
    
    Returns:
    
    The ARN of the metric stream.
  - withArn
```
public GetMetricStreamResult withArn(String arn)
```
    The ARN of the metric stream.
    
    Parameters:
    
    arn - The ARN of the metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the metric stream.
    
    Parameters:
    
    name - The name of the metric stream.
  - getName
```
public String getName()
```
    The name of the metric stream.
    
    Returns:
    
    The name of the metric stream.
  - withName
```
public GetMetricStreamResult withName(String name)
```
    The name of the metric stream.
    
    Parameters:
    
    name - The name of the metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIncludeFilters
```
public List<MetricStreamFilter> getIncludeFilters()
```
    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
    
    Returns:
    
    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
  - setIncludeFilters
```
public void setIncludeFilters(Collection<MetricStreamFilter> includeFilters)
```
    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
    
    Parameters:
    
    includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
  - withIncludeFilters
```
public GetMetricStreamResult withIncludeFilters(MetricStreamFilter... 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 setIncludeFilters(java.util.Collection) or withIncludeFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIncludeFilters
```
public GetMetricStreamResult withIncludeFilters(Collection<MetricStreamFilter> includeFilters)
```
    If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
    
    Parameters:
    
    includeFilters - If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludeFilters
```
public List<MetricStreamFilter> getExcludeFilters()
```
    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.
    
    Returns:
    
    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.
  - setExcludeFilters
```
public void setExcludeFilters(Collection<MetricStreamFilter> 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.
    
    Parameters:
    
    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.
  - withExcludeFilters
```
public GetMetricStreamResult withExcludeFilters(MetricStreamFilter... 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 setExcludeFilters(java.util.Collection) or withExcludeFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludeFilters
```
public GetMetricStreamResult withExcludeFilters(Collection<MetricStreamFilter> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFirehoseArn
```
public void setFirehoseArn(String firehoseArn)
```
    The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
    
    Parameters:
    
    firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
  - getFirehoseArn
```
public String getFirehoseArn()
```
    The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
    
    Returns:
    
    The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
  - withFirehoseArn
```
public GetMetricStreamResult withFirehoseArn(String firehoseArn)
```
    The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
    
    Parameters:
    
    firehoseArn - The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the IAM role that is used by this metric stream.
    
    Parameters:
    
    roleArn - The ARN of the IAM role that is used by this metric stream.
  - getRoleArn
```
public String getRoleArn()
```
    The ARN of the IAM role that is used by this metric stream.
    
    Returns:
    
    The ARN of the IAM role that is used by this metric stream.
  - withRoleArn
```
public GetMetricStreamResult withRoleArn(String roleArn)
```
    The ARN of the IAM role that is used by this metric stream.
    
    Parameters:
    
    roleArn - The ARN of the IAM role that is used by this metric stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the metric stream. The possible values are running and stopped.
    
    Parameters:
    
    state - The state of the metric stream. The possible values are running and stopped.
  - getState
```
public String getState()
```
    The state of the metric stream. The possible values are running and stopped.
    
    Returns:
    
    The state of the metric stream. The possible values are running and stopped.
  - withState
```
public GetMetricStreamResult withState(String state)
```
    The state of the metric stream. The possible values are running and stopped.
    
    Parameters:
    
    state - The state of the metric stream. The possible values are running and stopped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date that the metric stream was created.
    
    Parameters:
    
    creationDate - The date that the metric stream was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date that the metric stream was created.
    
    Returns:
    
    The date that the metric stream was created.
  - withCreationDate
```
public GetMetricStreamResult withCreationDate(Date creationDate)
```
    The date that the metric stream was created.
    
    Parameters:
    
    creationDate - The date that the metric stream was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdateDate
```
public void setLastUpdateDate(Date lastUpdateDate)
```
    The date of the most recent update to the metric stream's configuration.
    
    Parameters:
    
    lastUpdateDate - The date of the most recent update to the metric stream's configuration.
  - getLastUpdateDate
```
public Date getLastUpdateDate()
```
    The date of the most recent update to the metric stream's configuration.
    
    Returns:
    
    The date of the most recent update to the metric stream's configuration.
  - withLastUpdateDate
```
public GetMetricStreamResult withLastUpdateDate(Date lastUpdateDate)
```
    The date of the most recent update to the metric stream's configuration.
    
    Parameters:
    
    lastUpdateDate - The date of the most recent update to the metric stream's configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputFormat
```
public void setOutputFormat(String outputFormat)
```
    The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Parameters:
    
    outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    See Also:
    
    MetricStreamOutputFormat
  - getOutputFormat
```
public String getOutputFormat()
```
    The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Returns:
    
    The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    See Also:
    
    MetricStreamOutputFormat
  - withOutputFormat
```
public GetMetricStreamResult withOutputFormat(String outputFormat)
```
    The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Parameters:
    
    outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStreamOutputFormat
  - withOutputFormat
```
public GetMetricStreamResult withOutputFormat(MetricStreamOutputFormat outputFormat)
```
    The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Parameters:
    
    outputFormat - The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStreamOutputFormat
  - getStatisticsConfigurations
```
public List<MetricStreamStatisticsConfiguration> getStatisticsConfigurations()
```
    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.
    
    Returns:
    
    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.
  - setStatisticsConfigurations
```
public void setStatisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> 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.
    
    Parameters:
    
    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.
  - withStatisticsConfigurations
```
public GetMetricStreamResult withStatisticsConfigurations(MetricStreamStatisticsConfiguration... 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 setStatisticsConfigurations(java.util.Collection) or withStatisticsConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStatisticsConfigurations
```
public GetMetricStreamResult withStatisticsConfigurations(Collection<MetricStreamStatisticsConfiguration> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeLinkedAccountsMetrics
```
public void setIncludeLinkedAccountsMetrics(Boolean 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.
    
    Parameters:
    
    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.
  - getIncludeLinkedAccountsMetrics
```
public Boolean getIncludeLinkedAccountsMetrics()
```
    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.
    
    Returns:
    
    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.
  - withIncludeLinkedAccountsMetrics
```
public GetMetricStreamResult withIncludeLinkedAccountsMetrics(Boolean 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeLinkedAccountsMetrics
```
public Boolean isIncludeLinkedAccountsMetrics()
```
    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.
    
    Returns:
    
    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.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetMetricStreamResult clone()
```
    Overrides:
    
    clone in class Object

Class GetMetricStreamResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetMetricStreamResult

Method Detail

setArn

getArn

withArn

setName

getName

withName

getIncludeFilters

setIncludeFilters

withIncludeFilters

withIncludeFilters

getExcludeFilters

setExcludeFilters

withExcludeFilters

withExcludeFilters

setFirehoseArn

getFirehoseArn

withFirehoseArn

setRoleArn

getRoleArn

withRoleArn

setState

getState

withState

setCreationDate

getCreationDate

withCreationDate

setLastUpdateDate

getLastUpdateDate

withLastUpdateDate

setOutputFormat

getOutputFormat

withOutputFormat

withOutputFormat

getStatisticsConfigurations

setStatisticsConfigurations

withStatisticsConfigurations

withStatisticsConfigurations

setIncludeLinkedAccountsMetrics

getIncludeLinkedAccountsMetrics

withIncludeLinkedAccountsMetrics

isIncludeLinkedAccountsMetrics

toString

equals

hashCode

clone