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

Class CreateModelRequest

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

  • Method Details

    • modelName

      public final String modelName()

      The name for the machine learning model to be created.

      Returns:
      The name for the machine learning model to be created.

    • datasetName

      public final String datasetName()

      The name of the dataset for the machine learning model being created.

      Returns:
      The name of the dataset for the machine learning model being created.

    • datasetSchema

      public final DatasetSchema datasetSchema()

      The data schema for the machine learning model being created.

      Returns:
      The data schema for the machine learning model being created.

    • labelsInputConfiguration

      public final LabelsInputConfiguration labelsInputConfiguration()

      The input configuration for the labels being used for the machine learning model that's being created.

      Returns:
      The input configuration for the labels being used for the machine learning model that's being created.

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

    • trainingDataStartTime

      public final Instant trainingDataStartTime()

      Indicates the time reference in the dataset that should be used to begin the subset of training data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that should be used to begin the subset of training data for the machine learning model.

    • trainingDataEndTime

      public final Instant trainingDataEndTime()

      Indicates the time reference in the dataset that should be used to end the subset of training data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that should be used to end the subset of training data for the machine learning model.

    • evaluationDataStartTime

      public final Instant evaluationDataStartTime()

      Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the machine learning model.

    • evaluationDataEndTime

      public final Instant evaluationDataEndTime()

      Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the machine learning model.

      Returns:
      Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the machine learning model.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.

      Returns:
      The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.

    • dataPreProcessingConfiguration

      public final DataPreProcessingConfiguration dataPreProcessingConfiguration()

      The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

      Returns:
      The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

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

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

    • 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 machine learning model being created.

      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 machine learning model being created.

    • offCondition

      public final String offCondition()

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

      Returns:
      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

    • toBuilder

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

    • builder

      public static CreateModelRequest.Builder builder()

    • serializableBuilderClass

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