Class CreateAppRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAppRequest.Builder,
CreateAppRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appName()
The name of the app.final AppType
appType()
The type of app.final String
The type of app.static CreateAppRequest.Builder
builder()
final String
domainId()
The domain ID.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ResourceSpec
The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.static Class
<? extends CreateAppRequest.Builder> final String
The name of the space.tags()
Each tag consists of a key and an optional value.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The user profile name.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainId
The domain ID.
- Returns:
- The domain ID.
-
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
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
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:
-
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:
-
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
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
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
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 interfaceToCopyableBuilder<CreateAppRequest.Builder,
CreateAppRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-