Class StudioWebPortalSettings

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

Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

See Also:

  • Method Details

    • hiddenMlTools

      public final List<MlTools> hiddenMlTools()

      The machine learning tools that are hidden from the Studio left navigation pane.

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

      Returns:
      The machine learning tools that are hidden from the Studio left navigation pane.

    • hasHiddenMlTools

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

    • hiddenMlToolsAsStrings

      public final List<String> hiddenMlToolsAsStrings()

      The machine learning tools that are hidden from the Studio left navigation pane.

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

      Returns:
      The machine learning tools that are hidden from the Studio left navigation pane.

    • hiddenAppTypes

      public final List<AppType> hiddenAppTypes()

      The Applications supported in Studio that are hidden from the Studio left navigation pane.

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

      Returns:
      The Applications supported in Studio that are hidden from the Studio left navigation pane.

    • hasHiddenAppTypes

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

    • hiddenAppTypesAsStrings

      public final List<String> hiddenAppTypesAsStrings()

      The Applications supported in Studio that are hidden from the Studio left navigation pane.

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

      Returns:
      The Applications supported in Studio that are hidden from the Studio left navigation pane.

    • hiddenInstanceTypes

      public final List<AppInstanceType> hiddenInstanceTypes()

      The instance types you are hiding from the Studio user interface.

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

      Returns:
      The instance types you are hiding from the Studio user interface.

    • hasHiddenInstanceTypes

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

    • hiddenInstanceTypesAsStrings

      public final List<String> hiddenInstanceTypesAsStrings()

      The instance types you are hiding from the Studio user interface.

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

      Returns:
      The instance types you are hiding from the Studio user interface.

    • hasHiddenSageMakerImageVersionAliases

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

    • hiddenSageMakerImageVersionAliases

      public final List<HiddenSageMakerImage> hiddenSageMakerImageVersionAliases()

      The version aliases you are hiding from the Studio user interface.

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

      Returns:
      The version aliases you are hiding from the Studio user interface.

    • toBuilder

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

    • builder

      public static StudioWebPortalSettings.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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