CreateModelRequest (AWS Java SDK :: Services :: Lookout Equipment 2.18.21 API)

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(value="software.amazon.awssdk:codegen")
public final class CreateModelRequest
extends LookoutEquipmentRequest
implements ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateModelRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateModelRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateModelRequest.Builder`	`builder()`
`String`	`clientToken()` A unique identifier for the request.
`DataPreProcessingConfiguration`	`dataPreProcessingConfiguration()` The configuration is the `TargetSamplingRate`, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment.
`String`	`datasetName()` The name of the dataset for the ML model being created.
`DatasetSchema`	`datasetSchema()` The data schema for the ML model being created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`evaluationDataEndTime()` Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
`Instant`	`evaluationDataStartTime()` Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`LabelsInputConfiguration`	`labelsInputConfiguration()` The input configuration for the labels being used for the ML model that's being created.
`String`	`modelName()` The name for the ML model to be created.
`String`	`offCondition()` Indicates that the asset associated with this sensor has been shut off.
`String`	`roleArn()` The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateModelRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverSideKmsKeyId()` Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
`List<Tag>`	`tags()` Any tags associated with the ML model being created.
`CreateModelRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`trainingDataEndTime()` Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
`Instant`	`trainingDataStartTime()` Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - modelName
```
public final String modelName()
```
    The name for the ML model to be created.
    
    Returns:
    
    The name for the ML model to be created.
  - datasetName
```
public final String datasetName()
```
    The name of the dataset for the ML model being created.
    
    Returns:
    
    The name of the dataset for the ML model being created.
  - datasetSchema
```
public final DatasetSchema datasetSchema()
```
    The data schema for the ML model being created.
    
    Returns:
    
    The data schema for the ML model being created.
  - labelsInputConfiguration
```
public final LabelsInputConfiguration labelsInputConfiguration()
```
    The input configuration for the labels being used for the ML model that's being created.
    
    Returns:
    
    The input configuration for the labels being used for the ML 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 ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML 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 ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that should be used to end the subset of training data for the ML 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 ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML 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 ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML 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 ML model.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML 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 ML 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 ML 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>
    
    Specified by:
    
    toBuilder in class LookoutEquipmentRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateModelRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

modelName

datasetName

datasetSchema

labelsInputConfiguration

clientToken

trainingDataStartTime

trainingDataEndTime

evaluationDataStartTime

evaluationDataEndTime

roleArn

dataPreProcessingConfiguration

serverSideKmsKeyId

hasTags

tags

offCondition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields