Class CreateInferenceSchedulerRequest

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.CreateInferenceSchedulerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateInferenceSchedulerRequest.Builder,CreateInferenceSchedulerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateInferenceSchedulerRequest extends LookoutEquipmentRequest implements ToCopyableBuilder<CreateInferenceSchedulerRequest.Builder,CreateInferenceSchedulerRequest>

  • Method Details

    • modelName

      public final String modelName()

      The name of the previously trained machine learning model being used to create the inference scheduler.

      Returns:
      The name of the previously trained machine learning model being used to create the inference scheduler.

    • inferenceSchedulerName

      public final String inferenceSchedulerName()

      The name of the inference scheduler being created.

      Returns:
      The name of the inference scheduler being created.

    • dataDelayOffsetInMinutes

      public final Long dataDelayOffsetInMinutes()

      The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

      For more information, see Understanding the inference process.

      Returns:
      The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

      For more information, see Understanding the inference process.

    • dataUploadFrequency

      public final DataUploadFrequency dataUploadFrequency()

      How often data is uploaded to the source Amazon 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 runs inference on your data.

      For more information, see Understanding the inference process.

      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 Amazon 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 runs inference on your data.

      For more information, see Understanding the inference process.

      See Also:

    • dataUploadFrequencyAsString

      public final String dataUploadFrequencyAsString()

      How often data is uploaded to the source Amazon 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 runs inference on your data.

      For more information, see Understanding the inference process.

      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 Amazon 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 runs inference on your data.

      For more information, see Understanding the inference process.

      See Also:

    • dataInputConfiguration

      public final InferenceInputConfiguration dataInputConfiguration()

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

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

    • dataOutputConfiguration

      public final InferenceOutputConfiguration dataOutputConfiguration()

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

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

    • roleArn

      public final String roleArn()

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

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

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

      Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

      Returns:
      Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

    • clientToken

      public final String clientToken()

      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

      Returns:
      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      Any tags associated with the inference scheduler.

      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 hasTags() method.

      Returns:
      Any tags associated with the inference scheduler.

    • toBuilder

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

    • builder

      public static CreateInferenceSchedulerRequest.Builder builder()

    • serializableBuilderClass

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