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

Class CreateMetricSetRequest

    • Method Detail

      • anomalyDetectorArn

        public final String anomalyDetectorArn()

        The ARN of the anomaly detector that will use the dataset.

        Returns:
        The ARN of the anomaly detector that will use the dataset.

      • metricSetName

        public final String metricSetName()

        The name of the dataset.

        Returns:
        The name of the dataset.

      • metricSetDescription

        public final String metricSetDescription()

        A description of the dataset you are creating.

        Returns:
        A description of the dataset you are creating.

      • 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 metrics that the dataset will contain.

        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 metrics that the dataset will contain.

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

      • 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 fields you want to treat as dimensions.

        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 fields you want to treat as dimensions.

      • metricSetFrequencyAsString

        public final String metricSetFrequencyAsString()

        The frequency with which the source 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 frequency with which the source data will be analyzed for anomalies.
        See Also:
        Frequency

      • metricSource

        public final MetricSource metricSource()

        Contains information about how the source data should be interpreted.

        Returns:
        Contains information about how the source data should be interpreted.

      • timezone

        public final String timezone()

        The time zone in which your source data was recorded.

        Returns:
        The time zone in which your source data was recorded.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final Map<String,​String> tags()

        A list of tags to apply to 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 hasTags() method.

        Returns:
        A list of tags to apply to the dataset.

      • 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()

        A list of filters that specify which data is kept for anomaly detection.

        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:
        A list of filters that specify which data is kept for anomaly detection.

      • 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