CreateMetricSetRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.lookoutmetrics.model.LookoutMetricsRequest
    - - software.amazon.awssdk.services.lookoutmetrics.model.CreateMetricSetRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateMetricSetRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`anomalyDetectorArn()` The ARN of the anomaly detector that will use the dataset.
`static CreateMetricSetRequest.Builder`	`builder()`
`List<MetricSetDimensionFilter>`	`dimensionFilterList()` A list of filters that specify which data is kept for anomaly detection.
`List<String>`	`dimensionList()` A list of the fields you want to treat as dimensions.
`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.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<Metric>`	`metricList()` A list of metrics that the dataset will contain.
`String`	`metricSetDescription()` A description of the dataset you are creating.
`Frequency`	`metricSetFrequency()` The frequency with which the source data will be analyzed for anomalies.
`String`	`metricSetFrequencyAsString()` The frequency with which the source data will be analyzed for anomalies.
`String`	`metricSetName()` The name of the dataset.
`MetricSource`	`metricSource()` Contains information about how the source data should be interpreted.
`Integer`	`offset()` After an interval ends, the amount of seconds that the detector waits before importing data.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateMetricSetRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A list of tags to apply to the dataset.
`TimestampColumn`	`timestampColumn()` Contains information about the column used for tracking time in your source data.
`String`	`timezone()` The time zone in which your source data was recorded.
`CreateMetricSetRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - 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.
  - metricSetFrequency
```
public final Frequency metricSetFrequency()
```
    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
  - 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.
  - toBuilder
```
public CreateMetricSetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateMetricSetRequest.Builder,CreateMetricSetRequest>
    
    Specified by:
    
    toBuilder in class LookoutMetricsRequest
  - builder
```
public static CreateMetricSetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateMetricSetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateMetricSetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

anomalyDetectorArn

metricSetName

metricSetDescription

hasMetricList

metricList

offset

timestampColumn

hasDimensionList

dimensionList

metricSetFrequency

metricSetFrequencyAsString

metricSource

timezone

hasTags

tags

hasDimensionFilterList

dimensionFilterList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields