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

Interface CreateModelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>, LookoutEquipmentRequest.Builder, SdkBuilder<CreateModelRequest.Builder,CreateModelRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateModelRequest
public static interface CreateModelRequest.Builder extends LookoutEquipmentRequest.Builder, SdkPojo, CopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

  • Method Details

    • modelName

      CreateModelRequest.Builder modelName(String modelName)

      The name for the machine learning model to be created.

      Parameters:
      modelName - The name for the machine learning model to be created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetName

      CreateModelRequest.Builder datasetName(String datasetName)

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

      Parameters:
      datasetName - The name of the dataset for the machine learning model being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetSchema

      CreateModelRequest.Builder datasetSchema(DatasetSchema datasetSchema)

      The data schema for the machine learning model being created.

      Parameters:
      datasetSchema - The data schema for the machine learning model being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetSchema

      default CreateModelRequest.Builder datasetSchema(Consumer<DatasetSchema.Builder> datasetSchema)

      The data schema for the machine learning model being created.

      This is a convenience method that creates an instance of the DatasetSchema.Builder avoiding the need to create one manually via DatasetSchema.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetSchema(DatasetSchema).

      Parameters:
      datasetSchema - a consumer that will call methods on DatasetSchema.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • labelsInputConfiguration

      CreateModelRequest.Builder labelsInputConfiguration(LabelsInputConfiguration labelsInputConfiguration)

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

      Parameters:
      labelsInputConfiguration - The input configuration for the labels being used for the machine learning model that's being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • labelsInputConfiguration

      default CreateModelRequest.Builder labelsInputConfiguration(Consumer<LabelsInputConfiguration.Builder> labelsInputConfiguration)

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

      This is a convenience method that creates an instance of the LabelsInputConfiguration.Builder avoiding the need to create one manually via LabelsInputConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to labelsInputConfiguration(LabelsInputConfiguration).

      Parameters:
      labelsInputConfiguration - a consumer that will call methods on LabelsInputConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateModelRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingDataStartTime

      CreateModelRequest.Builder trainingDataStartTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • trainingDataEndTime

      CreateModelRequest.Builder trainingDataEndTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationDataStartTime

      CreateModelRequest.Builder evaluationDataStartTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • evaluationDataEndTime

      CreateModelRequest.Builder evaluationDataEndTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateModelRequest.Builder roleArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataPreProcessingConfiguration

      CreateModelRequest.Builder dataPreProcessingConfiguration(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dataPreProcessingConfiguration

      default CreateModelRequest.Builder dataPreProcessingConfiguration(Consumer<DataPreProcessingConfiguration.Builder> 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

      This is a convenience method that creates an instance of the DataPreProcessingConfiguration.Builder avoiding the need to create one manually via DataPreProcessingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataPreProcessingConfiguration(DataPreProcessingConfiguration).

      Parameters:
      dataPreProcessingConfiguration - a consumer that will call methods on DataPreProcessingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serverSideKmsKeyId

      CreateModelRequest.Builder serverSideKmsKeyId(String serverSideKmsKeyId)

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

      Parameters:
      serverSideKmsKeyId - Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateModelRequest.Builder tags(Collection<Tag> tags)

      Any tags associated with the machine learning model being created.

      Parameters:
      tags - Any tags associated with the machine learning model being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateModelRequest.Builder tags(Tag... tags)

      Any tags associated with the machine learning model being created.

      Parameters:
      tags - Any tags associated with the machine learning model being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateModelRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Any tags associated with the machine learning model being created.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • offCondition

      CreateModelRequest.Builder offCondition(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • modelDiagnosticsOutputConfiguration

      CreateModelRequest.Builder modelDiagnosticsOutputConfiguration(ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration)

      The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.

      Parameters:
      modelDiagnosticsOutputConfiguration - The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelDiagnosticsOutputConfiguration

      default CreateModelRequest.Builder modelDiagnosticsOutputConfiguration(Consumer<ModelDiagnosticsOutputConfiguration.Builder> modelDiagnosticsOutputConfiguration)

      The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the RoleArn request parameter.

      This is a convenience method that creates an instance of the ModelDiagnosticsOutputConfiguration.Builder avoiding the need to create one manually via ModelDiagnosticsOutputConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelDiagnosticsOutputConfiguration(ModelDiagnosticsOutputConfiguration).

      Parameters:
      modelDiagnosticsOutputConfiguration - a consumer that will call methods on ModelDiagnosticsOutputConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.