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

Class ImportModelVersionRequest

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

  • Method Details

    • sourceModelVersionArn

      public final String sourceModelVersionArn()

      The Amazon Resource Name (ARN) of the model version to import.

      Returns:
      The Amazon Resource Name (ARN) of the model version to import.

    • modelName

      public final String modelName()

      The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.

      Returns:
      The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.

    • datasetName

      public final String datasetName()

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

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

    • labelsInputConfiguration

      public final LabelsInputConfiguration labelsInputConfiguration()
      Returns the value of the LabelsInputConfiguration property for this object.
      Returns:
      The value of the LabelsInputConfiguration property for this object.

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

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

    • serverSideKmsKeyId

      public final String serverSideKmsKeyId()

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

      Returns:
      Provides the identifier of the KMS key 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()

      The tags associated with the machine learning model to be 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:
      The tags associated with the machine learning model to be created.

    • inferenceDataImportStrategy

      public final InferenceDataImportStrategy inferenceDataImportStrategy()

      Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:

      • NO_IMPORT – Don't import the data.

      • ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.

      • OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.

      If the service returns an enum value that is not available in the current SDK version, inferenceDataImportStrategy will return InferenceDataImportStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferenceDataImportStrategyAsString().

      Returns:
      Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:

      • NO_IMPORT – Don't import the data.

      • ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.

      • OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.

      See Also:

    • inferenceDataImportStrategyAsString

      public final String inferenceDataImportStrategyAsString()

      Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:

      • NO_IMPORT – Don't import the data.

      • ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.

      • OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.

      If the service returns an enum value that is not available in the current SDK version, inferenceDataImportStrategy will return InferenceDataImportStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferenceDataImportStrategyAsString().

      Returns:
      Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:

      • NO_IMPORT – Don't import the data.

      • ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model.

      • OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.

      See Also:

    • toBuilder

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

    • builder

      public static ImportModelVersionRequest.Builder builder()

    • serializableBuilderClass

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