Class StreamingImage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamingImage.Builder,
StreamingImage>
Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.static StreamingImage.Builder
builder()
final String
A human-readable description of the streaming image.final String
The ID of an EC2 machine image with which to create the streaming image.The encryption configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.eulaIds()
The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the EulaIds property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
A friendly name for a streaming image resource.final String
owner()
The owner of the streaming image, either thestudioId
that contains the streaming image, oramazon
for images that are provided by Amazon Nimble Studio.final String
platform()
The platform of the streaming image, either Windows or Linux.static Class
<? extends StreamingImage.Builder> final StreamingImageState
state()
The current state.final String
The current state.final StreamingImageStatusCode
The status code.final String
The status code.final String
The status message for the streaming image.final String
The ID of the streaming image.tags()
A collection of labels, in the form of key-value pairs, that apply to this resource.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
- Returns:
- The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
-
description
A human-readable description of the streaming image.
- Returns:
- A human-readable description of the streaming image.
-
ec2ImageId
The ID of an EC2 machine image with which to create the streaming image.
- Returns:
- The ID of an EC2 machine image with which to create the streaming image.
-
encryptionConfiguration
The encryption configuration.
- Returns:
- The encryption configuration.
-
hasEulaIds
public final boolean hasEulaIds()For responses, this returns true if the service returned a value for the EulaIds 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. -
eulaIds
The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
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
hasEulaIds()
method.- Returns:
- The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
-
name
A friendly name for a streaming image resource.
- Returns:
- A friendly name for a streaming image resource.
-
owner
The owner of the streaming image, either the
studioId
that contains the streaming image, oramazon
for images that are provided by Amazon Nimble Studio.- Returns:
- The owner of the streaming image, either the
studioId
that contains the streaming image, oramazon
for images that are provided by Amazon Nimble Studio.
-
platform
The platform of the streaming image, either Windows or Linux.
- Returns:
- The platform of the streaming image, either Windows or Linux.
-
state
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStreamingImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
stateAsString
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStreamingImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
statusCode
The status code.
If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnStreamingImageStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code.
- See Also:
-
statusCodeAsString
The status code.
If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnStreamingImageStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code.
- See Also:
-
statusMessage
The status message for the streaming image.
- Returns:
- The status message for the streaming image.
-
streamingImageId
The ID of the streaming image.
- Returns:
- The ID of the streaming 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
A collection of labels, in the form of key-value pairs, that apply to this 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:
- A collection of labels, in the form of key-value pairs, that apply to this resource.
-
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<StreamingImage.Builder,
StreamingImage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-