Class GetMetricStreamResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
-
- software.amazon.awssdk.services.cloudwatch.model.GetMetricStreamResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMetricStreamResponse extends CloudWatchResponse implements ToCopyableBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetMetricStreamResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
arn()
The ARN of the metric stream.static GetMetricStreamResponse.Builder
builder()
Instant
creationDate()
The date that the metric stream was created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<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.String
firehoseArn()
The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasExcludeFilters()
For responses, this returns true if the service returned a value for the ExcludeFilters property.int
hashCode()
boolean
hasIncludeFilters()
For responses, this returns true if the service returned a value for the IncludeFilters property.boolean
hasStatisticsConfigurations()
For responses, this returns true if the service returned a value for the StatisticsConfigurations property.List<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.Boolean
includeLinkedAccountsMetrics()
If this istrue
and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.Instant
lastUpdateDate()
The date of the most recent update to the metric stream's configuration.String
name()
The name of the metric stream.MetricStreamOutputFormat
outputFormat()
The output format for the stream.String
outputFormatAsString()
The output format for the stream.String
roleArn()
The ARN of the IAM role that is used by this metric stream.List<SdkField<?>>
sdkFields()
static Class<? extends GetMetricStreamResponse.Builder>
serializableBuilderClass()
String
state()
The state of the metric stream.List<MetricStreamStatisticsConfiguration>
statisticsConfigurations()
Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.GetMetricStreamResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final String arn()
The ARN of the metric stream.
- Returns:
- The ARN of the metric stream.
-
name
public final String name()
The name of the metric stream.
- Returns:
- The name of the metric stream.
-
hasIncludeFilters
public final boolean hasIncludeFilters()
For responses, this returns true if the service returned a value for the IncludeFilters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
includeFilters
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasIncludeFilters()
method.- Returns:
- If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.
-
hasExcludeFilters
public final boolean hasExcludeFilters()
For responses, this returns true if the service returned a value for the ExcludeFilters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
excludeFilters
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExcludeFilters()
method.- 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.
-
firehoseArn
public final String firehoseArn()
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.
-
roleArn
public final String roleArn()
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.
-
state
public final String state()
The state of the metric stream. The possible values are
running
andstopped
.- Returns:
- The state of the metric stream. The possible values are
running
andstopped
.
-
creationDate
public final Instant creationDate()
The date that the metric stream was created.
- Returns:
- The date that the metric stream was created.
-
lastUpdateDate
public final Instant lastUpdateDate()
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.
-
outputFormat
public final MetricStreamOutputFormat outputFormat()
The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnMetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats. - See Also:
MetricStreamOutputFormat
-
outputFormatAsString
public final String outputFormatAsString()
The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats.If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnMetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- The output format for the stream. Valid values are
json
,opentelemetry1.0
, andopentelemetry0.7
. For more information about metric stream output formats, see Metric streams output formats. - See Also:
MetricStreamOutputFormat
-
hasStatisticsConfigurations
public final boolean hasStatisticsConfigurations()
For responses, this returns true if the service returned a value for the StatisticsConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
statisticsConfigurations
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatisticsConfigurations()
method.- 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.
-
includeLinkedAccountsMetrics
public final 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.- 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.
-
toBuilder
public GetMetricStreamResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetMetricStreamResponse.Builder,GetMetricStreamResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static GetMetricStreamResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetMetricStreamResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-