Package software.amazon.awssdk.services.lookoutequipment.model

Class InferenceSchedulerSummary

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

Contains information about the specific inference scheduler, including data delay offset, model name and ARN, status, and so on.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of the machine learning model used for the inference scheduler.

      Returns:
      The name of the machine learning model used for the inference scheduler.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler.

      Returns:
      The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler.

    • inferenceSchedulerName

      public final String inferenceSchedulerName()

      The name of the inference scheduler.

      Returns:
      The name of the inference scheduler.

    • inferenceSchedulerArn

      public final String inferenceSchedulerArn()

      The Amazon Resource Name (ARN) of the inference scheduler.

      Returns:
      The Amazon Resource Name (ARN) of the inference scheduler.

    • status

      public final InferenceSchedulerStatus status()

      Indicates the status of the inference scheduler.

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

      Returns:
      Indicates the status of the inference scheduler.
      See Also:

    • statusAsString

      public final String statusAsString()

      Indicates the status of the inference scheduler.

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

      Returns:
      Indicates the status of the inference scheduler.
      See Also:

    • dataDelayOffsetInMinutes

      public final Long dataDelayOffsetInMinutes()

      A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

      Returns:
      A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

    • dataUploadFrequency

      public final DataUploadFrequency dataUploadFrequency()

      How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

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

      Returns:
      How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.
      See Also:

    • dataUploadFrequencyAsString

      public final String dataUploadFrequencyAsString()

      How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

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

      Returns:
      How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.
      See Also:

    • latestInferenceResult

      public final LatestInferenceResult latestInferenceResult()

      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

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

      Returns:
      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
      See Also:

    • latestInferenceResultAsString

      public final String latestInferenceResultAsString()

      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

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

      Returns:
      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
      See Also:

    • toBuilder

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

    • builder

      public static InferenceSchedulerSummary.Builder builder()

    • serializableBuilderClass

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