DescribeMetricSetResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.lookoutmetrics.model.LookoutMetricsResponse
    - - software.amazon.awssdk.services.lookoutmetrics.model.DescribeMetricSetResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeMetricSetResponse.Builder,DescribeMetricSetResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeMetricSetResponse
extends LookoutMetricsResponse
implements ToCopyableBuilder<DescribeMetricSetResponse.Builder,DescribeMetricSetResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeMetricSetResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeMetricSetResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`anomalyDetectorArn()` The ARN of the detector that contains the dataset.
`static DescribeMetricSetResponse.Builder`	`builder()`
`Instant`	`creationTime()` The time at which the dataset was created.
`List<MetricSetDimensionFilter>`	`dimensionFilterList()` The dimensions and their values that were used to filter the dataset.
`List<String>`	`dimensionList()` A list of the dimensions chosen for analysis.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDimensionFilterList()` For responses, this returns true if the service returned a value for the DimensionFilterList property.
`boolean`	`hasDimensionList()` For responses, this returns true if the service returned a value for the DimensionList property.
`int`	`hashCode()`
`boolean`	`hasMetricList()` For responses, this returns true if the service returned a value for the MetricList property.
`Instant`	`lastModificationTime()` The time at which the dataset was last modified.
`List<Metric>`	`metricList()` A list of the metrics defined by the dataset.
`String`	`metricSetArn()` The ARN of the dataset.
`String`	`metricSetDescription()` The dataset's description.
`Frequency`	`metricSetFrequency()` The interval at which the data will be analyzed for anomalies.
`String`	`metricSetFrequencyAsString()` The interval at which the data will be analyzed for anomalies.
`String`	`metricSetName()` The name of the dataset.
`MetricSource`	`metricSource()` Contains information about the dataset's source data.
`Integer`	`offset()` After an interval ends, the amount of seconds that the detector waits before importing data.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeMetricSetResponse.Builder>`	`serializableBuilderClass()`
`TimestampColumn`	`timestampColumn()` Contains information about the column used for tracking time in your source data.
`String`	`timezone()` The time zone in which the dataset's data was recorded.
`DescribeMetricSetResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lookoutmetrics.model.LookoutMetricsResponse
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
  - metricSetArn
```
public final String metricSetArn()
```
    The ARN of the dataset.
    
    Returns:
    
    The ARN of the dataset.
  - anomalyDetectorArn
```
public final String anomalyDetectorArn()
```
    The ARN of the detector that contains the dataset.
    
    Returns:
    
    The ARN of the detector that contains the dataset.
  - metricSetName
```
public final String metricSetName()
```
    The name of the dataset.
    
    Returns:
    
    The name of the dataset.
  - metricSetDescription
```
public final String metricSetDescription()
```
    The dataset's description.
    
    Returns:
    
    The dataset's description.
  - creationTime
```
public final Instant creationTime()
```
    The time at which the dataset was created.
    
    Returns:
    
    The time at which the dataset was created.
  - lastModificationTime
```
public final Instant lastModificationTime()
```
    The time at which the dataset was last modified.
    
    Returns:
    
    The time at which the dataset was last modified.
  - offset
```
public final Integer offset()
```
    After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
    
    Returns:
    
    After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
  - hasMetricList
```
public final boolean hasMetricList()
```
    For responses, this returns true if the service returned a value for the MetricList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - metricList
```
public final List<Metric> metricList()
```
    A list of the metrics defined by the dataset.
    
    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 hasMetricList() method.
    
    Returns:
    
    A list of the metrics defined by the dataset.
  - timestampColumn
```
public final TimestampColumn timestampColumn()
```
    Contains information about the column used for tracking time in your source data.
    
    Returns:
    
    Contains information about the column used for tracking time in your source data.
  - hasDimensionList
```
public final boolean hasDimensionList()
```
    For responses, this returns true if the service returned a value for the DimensionList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - dimensionList
```
public final List<String> dimensionList()
```
    A list of the dimensions chosen for analysis.
    
    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 hasDimensionList() method.
    
    Returns:
    
    A list of the dimensions chosen for analysis.
  - metricSetFrequency
```
public final Frequency metricSetFrequency()
```
    The interval at which the data will be analyzed for anomalies.
    
    If the service returns an enum value that is not available in the current SDK version, metricSetFrequency will return Frequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricSetFrequencyAsString().
    
    Returns:
    
    The interval at which the data will be analyzed for anomalies.
    
    See Also:
    
    Frequency
  - metricSetFrequencyAsString
```
public final String metricSetFrequencyAsString()
```
    The interval at which the data will be analyzed for anomalies.
    
    If the service returns an enum value that is not available in the current SDK version, metricSetFrequency will return Frequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricSetFrequencyAsString().
    
    Returns:
    
    The interval at which the data will be analyzed for anomalies.
    
    See Also:
    
    Frequency
  - timezone
```
public final String timezone()
```
    The time zone in which the dataset's data was recorded.
    
    Returns:
    
    The time zone in which the dataset's data was recorded.
  - metricSource
```
public final MetricSource metricSource()
```
    Contains information about the dataset's source data.
    
    Returns:
    
    Contains information about the dataset's source data.
  - hasDimensionFilterList
```
public final boolean hasDimensionFilterList()
```
    For responses, this returns true if the service returned a value for the DimensionFilterList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - dimensionFilterList
```
public final List<MetricSetDimensionFilter> dimensionFilterList()
```
    The dimensions and their values that were used to filter the dataset.
    
    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 hasDimensionFilterList() method.
    
    Returns:
    
    The dimensions and their values that were used to filter the dataset.
  - toBuilder
```
public DescribeMetricSetResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeMetricSetResponse.Builder,DescribeMetricSetResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeMetricSetResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeMetricSetResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeMetricSetResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lookoutmetrics.model.LookoutMetricsResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

metricSetArn

anomalyDetectorArn

metricSetName

metricSetDescription

creationTime

lastModificationTime

offset

hasMetricList

metricList

timestampColumn

hasDimensionList

dimensionList

metricSetFrequency

metricSetFrequencyAsString

timezone

metricSource

hasDimensionFilterList

dimensionFilterList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields