Class MetricQuery

java.lang.Object
software.amazon.awssdk.services.sagemakermetrics.model.MetricQuery
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MetricQuery.Builder,MetricQuery>
@Generated("software.amazon.awssdk:codegen") public final class MetricQuery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricQuery.Builder,MetricQuery>

Specifies a query to retrieve training metrics from SageMaker.

See Also:

  • Method Details

    • metricName

      public final String metricName()

      The name of the metric to retrieve.

      Returns:
      The name of the metric to retrieve.

    • resourceArn

      public final String resourceArn()

      The ARN of the SageMaker resource to retrieve metrics for.

      Returns:
      The ARN of the SageMaker resource to retrieve metrics for.

    • metricStat

      public final MetricStatistic metricStat()

      The metrics stat type of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, metricStat will return MetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricStatAsString().

      Returns:
      The metrics stat type of metrics to retrieve.
      See Also:

    • metricStatAsString

      public final String metricStatAsString()

      The metrics stat type of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, metricStat will return MetricStatistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricStatAsString().

      Returns:
      The metrics stat type of metrics to retrieve.
      See Also:

    • period

      public final Period period()

      The time period of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, period will return Period.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      Returns:
      The time period of metrics to retrieve.
      See Also:

    • periodAsString

      public final String periodAsString()

      The time period of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, period will return Period.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      Returns:
      The time period of metrics to retrieve.
      See Also:

    • xAxisType

      public final XAxisType xAxisType()

      The x-axis type of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, xAxisType will return XAxisType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from xAxisTypeAsString().

      Returns:
      The x-axis type of metrics to retrieve.
      See Also:

    • xAxisTypeAsString

      public final String xAxisTypeAsString()

      The x-axis type of metrics to retrieve.

      If the service returns an enum value that is not available in the current SDK version, xAxisType will return XAxisType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from xAxisTypeAsString().

      Returns:
      The x-axis type of metrics to retrieve.
      See Also:

    • start

      public final Long start()

      The start time of metrics to retrieve.

      Returns:
      The start time of metrics to retrieve.

    • end

      public final Long end()

      The end time of metrics to retrieve.

      Returns:
      The end time of metrics to retrieve.

    • toBuilder

      public MetricQuery.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<MetricQuery.Builder,MetricQuery>
      Returns:
      a builder for type T

    • builder

      public static MetricQuery.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MetricQuery.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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