Class ImportWorkspaceImageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ImportWorkspaceImageRequest.Builder,
ImportWorkspaceImageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<Application> If specified, the version of Microsoft Office to subscribe to.If specified, the version of Microsoft Office to subscribe to.builder()
final String
The identifier of the EC2 image.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 boolean
For responses, this returns true if the service returned a value for the Applications property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The description of the WorkSpace image.final String
The name of the WorkSpace image.The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP).final String
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP).static Class
<? extends ImportWorkspaceImageRequest.Builder> tags()
The tags.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ec2ImageId
The identifier of the EC2 image.
- Returns:
- The identifier of the EC2 image.
-
ingestionProcess
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.If the service returns an enum value that is not available in the current SDK version,
ingestionProcess
will returnWorkspaceImageIngestionProcess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromingestionProcessAsString()
.- Returns:
- The ingestion process to be used when importing the image, depending on which protocol you want to use
for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own
protocol (BYOP). To use WSP, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core. - See Also:
-
ingestionProcessAsString
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.If the service returns an enum value that is not available in the current SDK version,
ingestionProcess
will returnWorkspaceImageIngestionProcess.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromingestionProcessAsString()
.- Returns:
- The ingestion process to be used when importing the image, depending on which protocol you want to use
for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own
protocol (BYOP). To use WSP, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core. - See Also:
-
imageName
The name of the WorkSpace image.
- Returns:
- The name of the WorkSpace image.
-
imageDescription
The description of the WorkSpace image.
- Returns:
- The description of the WorkSpace image.
-
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
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
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:
- The tags. Each WorkSpaces resource can have a maximum of 50 tags.
-
applications
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
-
Although this parameter is an array, only one item is allowed at this time.
-
Windows 11 only supports
Microsoft_Office_2019
.
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
hasApplications()
method.- Returns:
- If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL
images. For more information about subscribing to Office for BYOL images, see Bring Your Own
Windows Desktop Licenses.
-
Although this parameter is an array, only one item is allowed at this time.
-
Windows 11 only supports
Microsoft_Office_2019
.
-
-
-
hasApplications
public final boolean hasApplications()For responses, this returns true if the service returned a value for the Applications 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. -
applicationsAsStrings
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
-
Although this parameter is an array, only one item is allowed at this time.
-
Windows 11 only supports
Microsoft_Office_2019
.
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
hasApplications()
method.- Returns:
- If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL
images. For more information about subscribing to Office for BYOL images, see Bring Your Own
Windows Desktop Licenses.
-
Although this parameter is an array, only one item is allowed at this time.
-
Windows 11 only supports
Microsoft_Office_2019
.
-
-
-
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<ImportWorkspaceImageRequest.Builder,
ImportWorkspaceImageRequest> - Specified by:
toBuilder
in classWorkSpacesRequest
- 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
-