Package software.amazon.awssdk.services.sagemaker.model

Class KernelGatewayAppSettings

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

The KernelGateway app settings.

See Also:

  • Method Details

    • defaultResourceSpec

      public final ResourceSpec defaultResourceSpec()

      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

      The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

      Returns:
      The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

      The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not passed.

    • hasCustomImages

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

    • customImages

      public final List<CustomImage> customImages()

      A list of custom SageMaker images that are configured to run as a KernelGateway app.

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

      Returns:
      A list of custom SageMaker images that are configured to run as a KernelGateway app.

    • hasLifecycleConfigArns

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

    • lifecycleConfigArns

      public final List<String> lifecycleConfigArns()

      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

      To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

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

      Returns:
      The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

      To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

    • toBuilder

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

    • builder

      public static KernelGatewayAppSettings.Builder builder()

    • serializableBuilderClass

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