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

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse
    - - software.amazon.awssdk.services.lookoutequipment.model.DescribeModelResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeModelResponse
extends LookoutEquipmentResponse
implements ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeModelResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeModelResponse.Builder`	`builder()`
`Instant`	`createdAt()` Indicates the time and date at which the ML model was created.
`DataPreProcessingConfiguration`	`dataPreProcessingConfiguration()` The configuration is the `TargetSamplingRate`, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment.
`String`	`datasetArn()` The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
`String`	`datasetName()` The name of the dataset being used by the ML being described.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Instant`	`evaluationDataEndTime()` Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.
`Instant`	`evaluationDataStartTime()` Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.
`String`	`failedReason()` If the training of the ML model failed, this indicates the reason for that failure.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LabelsInputConfiguration`	`labelsInputConfiguration()` Specifies configuration information about the labels input, including its S3 location.
`Instant`	`lastUpdatedTime()` Indicates the last time the ML model was updated.
`String`	`modelArn()` The Amazon Resource Name (ARN) of the ML model being described.
`String`	`modelMetrics()` The Model Metrics show an aggregated summary of the model's performance within the evaluation time range.
`String`	`modelName()` The name of the ML model being described.
`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 for the ML model being described.
`String`	`schema()` A JSON description of the data that is in each time series dataset, including names, column names, and data types.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeModelResponse.Builder>`	`serializableBuilderClass()`
`String`	`serverSideKmsKeyId()` Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
`ModelStatus`	`status()` Specifies the current status of the model being described.
`String`	`statusAsString()` Specifies the current status of the model being described.
`DescribeModelResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`trainingDataEndTime()` Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.
`Instant`	`trainingDataStartTime()` Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
`Instant`	`trainingExecutionEndTime()` Indicates the time at which the training of the ML model was completed.
`Instant`	`trainingExecutionStartTime()` Indicates the time at which the training of the ML model began.

Methods inherited from class software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 of the ML model being described.
    
    Returns:
    
    The name of the ML model being described.
  - modelArn
```
public final String modelArn()
```
    The Amazon Resource Name (ARN) of the ML model being described.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the ML model being described.
  - datasetName
```
public final String datasetName()
```
    The name of the dataset being used by the ML being described.
    
    Returns:
    
    The name of the dataset being used by the ML being described.
  - datasetArn
```
public final String datasetArn()
```
    The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
    
    Returns:
    
    The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.
  - schema
```
public final String schema()
```
    A JSON description of the data that is in each time series dataset, including names, column names, and data types.
    
    Returns:
    
    A JSON description of the data that is in each time series dataset, including names, column names, and data types.
  - labelsInputConfiguration
```
public final LabelsInputConfiguration labelsInputConfiguration()
```
    Specifies configuration information about the labels input, including its S3 location.
    
    Returns:
    
    Specifies configuration information about the labels input, including its S3 location.
  - trainingDataStartTime
```
public final Instant trainingDataStartTime()
```
    Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that was 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 was used to end the subset of training data for the ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that was 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 was used to begin the subset of evaluation data for the ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that was 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 was used to end the subset of evaluation data for the ML model.
    
    Returns:
    
    Indicates the time reference in the dataset that was 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 for the ML model being described.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.
  - 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
  - status
```
public final ModelStatus status()
```
    Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
    
    See Also:
    
    ModelStatus
  - statusAsString
```
public final String statusAsString()
```
    Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Specifies the current status of the model being described. Status describes the status of the most recent action of the model.
    
    See Also:
    
    ModelStatus
  - trainingExecutionStartTime
```
public final Instant trainingExecutionStartTime()
```
    Indicates the time at which the training of the ML model began.
    
    Returns:
    
    Indicates the time at which the training of the ML model began.
  - trainingExecutionEndTime
```
public final Instant trainingExecutionEndTime()
```
    Indicates the time at which the training of the ML model was completed.
    
    Returns:
    
    Indicates the time at which the training of the ML model was completed.
  - failedReason
```
public final String failedReason()
```
    If the training of the ML model failed, this indicates the reason for that failure.
    
    Returns:
    
    If the training of the ML model failed, this indicates the reason for that failure.
  - modelMetrics
```
public final String modelMetrics()
```
    The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
    
    Returns:
    
    The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    Indicates the last time the ML model was updated. The type of update is not specified.
    
    Returns:
    
    Indicates the last time the ML model was updated. The type of update is not specified.
  - createdAt
```
public final Instant createdAt()
```
    Indicates the time and date at which the ML model was created.
    
    Returns:
    
    Indicates the time and date at which the ML model was created.
  - 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.
  - 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 DescribeModelResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeModelResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeModelResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeModelResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lookoutequipment.model.LookoutEquipmentResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

modelName

modelArn

datasetName

datasetArn

schema

labelsInputConfiguration

trainingDataStartTime

trainingDataEndTime

evaluationDataStartTime

evaluationDataEndTime

roleArn

dataPreProcessingConfiguration

status

statusAsString

trainingExecutionStartTime

trainingExecutionEndTime

failedReason

modelMetrics

lastUpdatedTime

createdAt

serverSideKmsKeyId

offCondition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields