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("software.amazon.awssdk:codegen") public final class UpdateMetricSetRequest extends LookoutMetricsRequest implements ToCopyableBuilder<UpdateMetricSetRequest.Builder,UpdateMetricSetRequest>

  • Method Details

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

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

    • 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()
      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 interface ToCopyableBuilder<UpdateMetricSetRequest.Builder,UpdateMetricSetRequest>
      Specified by:
      toBuilder in class LookoutMetricsRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.