Class CreateMetricSetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateMetricSetRequest.Builder,
CreateMetricSetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the anomaly detector that will use the dataset.builder()
final List
<MetricSetDimensionFilter> A list of filters that specify which data is kept for anomaly detection.A list of the fields you want to treat as dimensions.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DimensionFilterList property.final boolean
For responses, this returns true if the service returned a value for the DimensionList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MetricList property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.A list of metrics that the dataset will contain.final String
A description of the dataset you are creating.final Frequency
The frequency with which the source data will be analyzed for anomalies.final String
The frequency with which the source data will be analyzed for anomalies.final String
The name of the dataset.final MetricSource
Contains information about how the source data should be interpreted.final Integer
offset()
After an interval ends, the amount of seconds that the detector waits before importing data.static Class
<? extends CreateMetricSetRequest.Builder> tags()
A list of tags to apply to the dataset.final TimestampColumn
Contains information about the column used for tracking time in your source data.final String
timezone()
The time zone in which your source data was recorded.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The name of the dataset.
- Returns:
- The name of the dataset.
-
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 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. -
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
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
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 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. -
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
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 returnFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricSetFrequencyAsString()
.- Returns:
- The frequency with which the source data will be analyzed for anomalies.
- See Also:
-
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 returnFrequency.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricSetFrequencyAsString()
.- Returns:
- The frequency with which the source data will be analyzed for anomalies.
- See Also:
-
metricSource
Contains information about how the source data should be interpreted.
- Returns:
- Contains information about how the source data should be interpreted.
-
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 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. -
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 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. -
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateMetricSetRequest.Builder,
CreateMetricSetRequest> - Specified by:
toBuilder
in classLookoutMetricsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-