Package software.amazon.awssdk.services.lookoutmetrics.model

Class DescribeMetricSetResponse

    • 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.

      • 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.

      • 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