Class Model

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.Model
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Model.Builder,Model>
@Generated("software.amazon.awssdk:codegen") public final class Model extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Model.Builder,Model>

The properties of a model as returned by the Search API.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of the model.

      Returns:
      The name of the model.

    • primaryContainer

      public final ContainerDefinition primaryContainer()
      Returns the value of the PrimaryContainer property for this object.
      Returns:
      The value of the PrimaryContainer property for this object.

    • hasContainers

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

    • containers

      public final List<ContainerDefinition> containers()

      The containers in the inference pipeline.

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

      Returns:
      The containers in the inference pipeline.

    • inferenceExecutionConfig

      public final InferenceExecutionConfig inferenceExecutionConfig()
      Returns the value of the InferenceExecutionConfig property for this object.
      Returns:
      The value of the InferenceExecutionConfig property for this object.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

    • vpcConfig

      public final VpcConfig vpcConfig()
      Returns the value of the VpcConfig property for this object.
      Returns:
      The value of the VpcConfig property for this object.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the model was created.

      Returns:
      A timestamp that indicates when the model was created.

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the model.

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

    • enableNetworkIsolation

      public final Boolean enableNetworkIsolation()

      Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

      Returns:
      Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

    • 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()

      A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

      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:
      A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

    • deploymentRecommendation

      public final DeploymentRecommendation deploymentRecommendation()

      A set of recommended deployment configurations for the model.

      Returns:
      A set of recommended deployment configurations for the model.

    • toBuilder

      public Model.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<Model.Builder,Model>
      Returns:
      a builder for type T

    • builder

      public static Model.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Model.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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