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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateAppRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
appName()
The name of the app.AppType
appType()
The type of app.String
appTypeAsString()
The type of app.static CreateAppRequest.Builder
builder()
String
domainId()
The domain ID.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.ResourceSpec
resourceSpec()
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.List<SdkField<?>>
sdkFields()
static Class<? extends CreateAppRequest.Builder>
serializableBuilderClass()
String
spaceName()
The name of the space.List<Tag>
tags()
Each tag consists of a key and an optional value.CreateAppRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
userProfileName()
The user profile name.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappTypeAsString()
.- Returns:
- The type of app.
- See Also:
AppType
-
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 returnAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromappTypeAsString()
.- Returns:
- The type of app.
- See Also:
AppType
-
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 theisEmpty()
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 theResourceSpec
in theCreateApp
call overrides the value passed as part of theResourceSpec
configured for the user profile or the domain. IfInstanceType
is not specified in any of those threeResourceSpec
values for aKernelGateway
app, theCreateApp
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 theResourceSpec
in theCreateApp
call overrides the value passed as part of theResourceSpec
configured for the user profile or the domain. IfInstanceType
is not specified in any of those threeResourceSpec
values for aKernelGateway
app, theCreateApp
call fails with a request validation error.
-
toBuilder
public CreateAppRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateAppRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAppRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-