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

Class UpdateInferenceSchedulerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentRequest
software.amazon.awssdk.services.lookoutequipment.model.UpdateInferenceSchedulerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateInferenceSchedulerRequest.Builder,UpdateInferenceSchedulerRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateInferenceSchedulerRequest extends LookoutEquipmentRequest implements ToCopyableBuilder<UpdateInferenceSchedulerRequest.Builder,UpdateInferenceSchedulerRequest>

  • Method Details

    • inferenceSchedulerName

      public final String inferenceSchedulerName()

      The name of the inference scheduler to be updated.

      Returns:
      The name of the inference scheduler to be updated.

    • 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 you select an offset delay time of five minutes, 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 you select an offset delay time of five minutes, 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. The value chosen 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. The value chosen 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. The value chosen 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. The value chosen 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:

    • dataInputConfiguration

      public final InferenceInputConfiguration dataInputConfiguration()

      Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

      Returns:
      Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

    • dataOutputConfiguration

      public final InferenceOutputConfiguration dataOutputConfiguration()

      Specifies information for the output results from the inference scheduler, including the output S3 location.

      Returns:
      Specifies information for the output results from the inference scheduler, including the output S3 location.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

      Returns:
      The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

    • toBuilder

      public UpdateInferenceSchedulerRequest.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<UpdateInferenceSchedulerRequest.Builder,UpdateInferenceSchedulerRequest>
      Specified by:
      toBuilder in class LookoutEquipmentRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateInferenceSchedulerRequest.Builder builder()

    • serializableBuilderClass

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