Class GetCollaborationTrainedModelResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse
software.amazon.awssdk.services.cleanroomsml.model.GetCollaborationTrainedModelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCollaborationTrainedModelResponse.Builder,GetCollaborationTrainedModelResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCollaborationTrainedModelResponse extends CleanRoomsMlResponse implements ToCopyableBuilder<GetCollaborationTrainedModelResponse.Builder,GetCollaborationTrainedModelResponse>

  • Method Details

    • membershipIdentifier

      public final String membershipIdentifier()

      The membership ID of the member that created the trained model.

      Returns:
      The membership ID of the member that created the trained model.

    • collaborationIdentifier

      public final String collaborationIdentifier()

      The collaboration ID of the collaboration that contains the trained model.

      Returns:
      The collaboration ID of the collaboration that contains the trained model.

    • trainedModelArn

      public final String trainedModelArn()

      The Amazon Resource Name (ARN) of the trained model.

      Returns:
      The Amazon Resource Name (ARN) of the trained model.

    • versionIdentifier

      public final String versionIdentifier()

      The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

      Returns:
      The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.

    • hasIncrementalTrainingDataChannels

      public final boolean hasIncrementalTrainingDataChannels()
      For responses, this returns true if the service returned a value for the IncrementalTrainingDataChannels 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.

    • incrementalTrainingDataChannels

      public final List<IncrementalTrainingDataChannelOutput> incrementalTrainingDataChannels()

      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

      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 hasIncrementalTrainingDataChannels() method.

      Returns:
      Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

    • name

      public final String name()

      The name of the trained model.

      Returns:
      The name of the trained model.

    • description

      public final String description()

      The description of the trained model.

      Returns:
      The description of the trained model.

    • status

      public final TrainedModelStatus status()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the trained model.

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

      Returns:
      The status of the trained model.
      See Also:

    • statusDetails

      public final StatusDetails statusDetails()
      Returns the value of the StatusDetails property for this object.
      Returns:
      The value of the StatusDetails property for this object.

    • configuredModelAlgorithmAssociationArn

      public final String configuredModelAlgorithmAssociationArn()

      The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

      Returns:
      The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.

    • resourceConfig

      public final ResourceConfig resourceConfig()

      The EC2 resource configuration that was used to train this model.

      Returns:
      The EC2 resource configuration that was used to train this model.

    • trainingInputMode

      public final TrainingInputMode trainingInputMode()

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

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

      Returns:
      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      See Also:

    • trainingInputModeAsString

      public final String trainingInputModeAsString()

      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

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

      Returns:
      The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.
      See Also:

    • stoppingCondition

      public final StoppingCondition stoppingCondition()

      The stopping condition that determined when model training ended.

      Returns:
      The stopping condition that determined when model training ended.

    • metricsStatus

      public final MetricsStatus metricsStatus()

      The status of the model metrics.

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

      Returns:
      The status of the model metrics.
      See Also:

    • metricsStatusAsString

      public final String metricsStatusAsString()

      The status of the model metrics.

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

      Returns:
      The status of the model metrics.
      See Also:

    • metricsStatusDetails

      public final String metricsStatusDetails()

      Details about the status information for the model metrics.

      Returns:
      Details about the status information for the model metrics.

    • logsStatus

      public final LogsStatus logsStatus()

      Status information for the logs.

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

      Returns:
      Status information for the logs.
      See Also:

    • logsStatusAsString

      public final String logsStatusAsString()

      Status information for the logs.

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

      Returns:
      Status information for the logs.
      See Also:

    • logsStatusDetails

      public final String logsStatusDetails()

      Details about the status information for the logs.

      Returns:
      Details about the status information for the logs.

    • trainingContainerImageDigest

      public final String trainingContainerImageDigest()

      Information about the training container image.

      Returns:
      Information about the training container image.

    • createTime

      public final Instant createTime()

      The time at which the trained model was created.

      Returns:
      The time at which the trained model was created.

    • updateTime

      public final Instant updateTime()

      The most recent time at which the trained model was updated.

      Returns:
      The most recent time at which the trained model was updated.

    • creatorAccountId

      public final String creatorAccountId()

      The account ID of the member that created the trained model.

      Returns:
      The account ID of the member that created the trained model.

    • toBuilder

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

    • builder

      public static GetCollaborationTrainedModelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCollaborationTrainedModelResponse.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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.