Class CreateAppRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.CreateAppRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAppRequest extends SageMakerRequest implements ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

  • Method Details

    • domainId

      public final String domainId()

      The domain ID.

      Returns:
      The domain ID.

    • userProfileName

      public final String userProfileName()

      The user profile name. If this value is not set, then SpaceName must be set.

      Returns:
      The user profile name. If this value is not set, then SpaceName must be set.

    • spaceName

      public final String spaceName()

      The name of the space. If this value is not set, then UserProfileName must be set.

      Returns:
      The name of the space. If this value is not set, then UserProfileName must be set.

    • appType

      public final AppType appType()

      The type of app.

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

      Returns:
      The type of app.
      See Also:

    • appTypeAsString

      public final String appTypeAsString()

      The type of app.

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

      Returns:
      The type of app.
      See Also:

    • appName

      public final String appName()

      The name of the app.

      Returns:
      The name of the app.

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

      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

      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:
      Each tag consists of a key and an optional value. Tag keys must be unique per resource.

    • resourceSpec

      public final ResourceSpec resourceSpec()

      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

      Returns:
      The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

      The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

    • toBuilder

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

    • builder

      public static CreateAppRequest.Builder builder()

    • serializableBuilderClass

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