software.amazon.awssdk.services.lookoutmetrics.model

Class UpdateMetricSetRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateMetricSetRequest.Builder,UpdateMetricSetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateMetricSetRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateMetricSetRequest.Builder	builder()
List<MetricSetDimensionFilter>	dimensionFilterList() Describes a list of filters for choosing specific dimensions and specific values.
List<String>	dimensionList() The dimension list.
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.
List<Metric>	metricList() The metric list.
String	metricSetArn() The ARN of the dataset to update.
String	metricSetDescription() The dataset's description.
Frequency	metricSetFrequency() The dataset's interval.
String	metricSetFrequencyAsString() The dataset's interval.
MetricSource	metricSource() Returns the value of the MetricSource property for this object.
Integer	offset() After an interval ends, the amount of seconds that the detector waits before importing data.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateMetricSetRequest.Builder>	serializableBuilderClass()
TimestampColumn	timestampColumn() The timestamp column.
UpdateMetricSetRequest.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

metricSetArn

public final String metricSetArn()

The ARN of the dataset to update.

Returns:

The ARN of the dataset to update.

metricSetDescription

public final String metricSetDescription()

The dataset's description.

Returns:

The dataset's description.

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

The metric list.

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:

The metric list.

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

The timestamp column.

Returns:

The timestamp column.

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

The dimension list.

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:

The dimension list.

metricSetFrequency

public final Frequency metricSetFrequency()

The dataset's interval.

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 dataset's interval.

See Also:

Frequency

metricSetFrequencyAsString

public final String metricSetFrequencyAsString()

The dataset's interval.

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 dataset's interval.

See Also:

Frequency

metricSource

public final MetricSource metricSource()

Returns the value of the MetricSource property for this object.

Returns:

The value of the MetricSource property for this object.

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

Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

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:

Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

toBuilder

public UpdateMetricSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateMetricSetRequest.Builder,UpdateMetricSetRequest>

Specified by:

toBuilder in class LookoutMetricsRequest

builder

public static UpdateMetricSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateMetricSetRequest.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