java.lang.Object
- software.amazon.awssdk.services.nimble.model.StreamingImage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamingImage.Builder,StreamingImage>
```
@Generated("software.amazon.awssdk:codegen")
public final class StreamingImage
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StreamingImage.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
`static StreamingImage.Builder`	`builder()`
`String`	`description()`	A human-readable description of the streaming image.
`String`	`ec2ImageId()`	The ID of an EC2 machine image with which to create the streaming image.
`StreamingImageEncryptionConfiguration`	`encryptionConfiguration()`	The encryption configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`eulaIds()`	The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEulaIds()`	For responses, this returns true if the service returned a value for the EulaIds property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()`	A friendly name for a streaming image resource.
`String`	`owner()`	The owner of the streaming image, either the `studioId` that contains the streaming image, or `amazon` for images that are provided by Amazon Nimble Studio.
`String`	`platform()`	The platform of the streaming image, either Windows or Linux.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StreamingImage.Builder>`	`serializableBuilderClass()`
`StreamingImageState`	`state()`	The current state.
`String`	`stateAsString()`	The current state.
`StreamingImageStatusCode`	`statusCode()`	The status code.
`String`	`statusCodeAsString()`	The status code.
`String`	`statusMessage()`	The status message for the streaming image.
`String`	`streamingImageId()`	The ID of the streaming image.
`Map<String,String>`	`tags()`	A collection of labels, in the form of key-value pairs, that apply to this resource.
`StreamingImage.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - arn
```
public final String 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
```
public final String description()
```
    A human-readable description of the streaming image.
    
    Returns:
    
    A human-readable description of the streaming image.
  - ec2ImageId
```
public final String 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
```
public final StreamingImageEncryptionConfiguration 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 the isEmpty() 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
```
public final List<String> 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
```
public final String name()
```
    A friendly name for a streaming image resource.
    
    Returns:
    
    A friendly name for a streaming image resource.
  - owner
```
public final String owner()
```
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
    
    Returns:
    
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
  - platform
```
public final String platform()
```
    The platform of the streaming image, either Windows or Linux.
    
    Returns:
    
    The platform of the streaming image, either Windows or Linux.
  - state
```
public final StreamingImageState state()
```
    The current state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return StreamingImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state.
    
    See Also:
    
    StreamingImageState
  - stateAsString
```
public final String stateAsString()
```
    The current state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return StreamingImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state.
    
    See Also:
    
    StreamingImageState
  - statusCode
```
public final StreamingImageStatusCode statusCode()
```
    The status code.
    
    If the service returns an enum value that is not available in the current SDK version, statusCode() will return StreamingImageStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    
    Returns:
    
    The status code.
    
    See Also:
    
    StreamingImageStatusCode
  - statusCodeAsString
```
public final String statusCodeAsString()
```
    The status code.
    
    If the service returns an enum value that is not available in the current SDK version, statusCode() will return StreamingImageStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    
    Returns:
    
    The status code.
    
    See Also:
    
    StreamingImageStatusCode
  - statusMessage
```
public final String statusMessage()
```
    The status message for the streaming image.
    
    Returns:
    
    The status message for the streaming image.
  - streamingImageId
```
public final String 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 the isEmpty() 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 Map<String,String> 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
```
public StreamingImage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StreamingImage.Builder,StreamingImage>
  - builder
```
public static StreamingImage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StreamingImage.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StreamingImage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

description

ec2ImageId

encryptionConfiguration

hasEulaIds

eulaIds

name

owner

platform

state

stateAsString

statusCode

statusCodeAsString

statusMessage

streamingImageId

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields