Class CreateUpdatedImageRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.appstream.model.AppStreamRequest
-
- software.amazon.awssdk.services.appstream.model.CreateUpdatedImageRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateUpdatedImageRequest.Builder,CreateUpdatedImageRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateUpdatedImageRequest extends AppStreamRequest implements ToCopyableBuilder<CreateUpdatedImageRequest.Builder,CreateUpdatedImageRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateUpdatedImageRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateUpdatedImageRequest.Builderbuilder()BooleandryRun()Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexistingImageName()The name of the image to update.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNewImageTags()For responses, this returns true if the service returned a value for the NewImageTags property.StringnewImageDescription()The description to display for the new image.StringnewImageDisplayName()The name to display for the new image.StringnewImageName()The name of the new image.Map<String,String>newImageTags()The tags to associate with the new image.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateUpdatedImageRequest.Builder>serializableBuilderClass()CreateUpdatedImageRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
existingImageName
public final String existingImageName()
The name of the image to update.
- Returns:
- The name of the image to update.
-
newImageName
public final String newImageName()
The name of the new image. The name must be unique within the AWS account and Region.
- Returns:
- The name of the new image. The name must be unique within the AWS account and Region.
-
newImageDescription
public final String newImageDescription()
The description to display for the new image.
- Returns:
- The description to display for the new image.
-
newImageDisplayName
public final String newImageDisplayName()
The name to display for the new image.
- Returns:
- The name to display for the new image.
-
hasNewImageTags
public final boolean hasNewImageTags()
For responses, this returns true if the service returned a value for the NewImageTags 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.
-
newImageTags
public final Map<String,String> newImageTags()
The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
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
hasNewImageTags()method.- Returns:
- The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For
example, Environment=Test. If you do not specify a value, Environment=.
Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
_ . : / = + \ - @
If you do not specify a value, the value is set to an empty string.
For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
-
dryRun
public final Boolean dryRun()
Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to
true, AppStream 2.0 displays whether image updates are available. If this value is set tofalse, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.- Returns:
- Indicates whether to display the status of image update availability before AppStream 2.0 initiates the
process of creating a new updated image. If this value is set to
true, AppStream 2.0 displays whether image updates are available. If this value is set tofalse, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
-
toBuilder
public CreateUpdatedImageRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateUpdatedImageRequest.Builder,CreateUpdatedImageRequest>- Specified by:
toBuilderin classAppStreamRequest
-
builder
public static CreateUpdatedImageRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateUpdatedImageRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-