Class GetSceneResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSceneResponse.Builder,
GetSceneResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the scene.static GetSceneResponse.Builder
builder()
A list of capabilities that the scene uses to render.final String
The relative path that specifies the location of the content definition file.final Instant
The date and time when the scene was created.final String
The description of the scene.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SceneError
error()
The SceneResponse error.The generated scene metadata.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Capabilities property.final boolean
For responses, this returns true if the service returned a value for the GeneratedSceneMetadata property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SceneMetadata property.final String
sceneId()
The ID of the scene.The response metadata.static Class
<? extends GetSceneResponse.Builder> 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 Instant
The date and time when the scene was last updated.final String
The ID of the workspace that contains the scene.Methods inherited from class software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workspaceId
The ID of the workspace that contains the scene.
- Returns:
- The ID of the workspace that contains the scene.
-
sceneId
The ID of the scene.
- Returns:
- The ID of the scene.
-
contentLocation
The relative path that specifies the location of the content definition file.
- Returns:
- The relative path that specifies the location of the content definition file.
-
arn
The ARN of the scene.
- Returns:
- The ARN of the scene.
-
creationDateTime
The date and time when the scene was created.
- Returns:
- The date and time when the scene was created.
-
updateDateTime
The date and time when the scene was last updated.
- Returns:
- The date and time when the scene was last updated.
-
description
The description of the scene.
- Returns:
- The description of the scene.
-
hasCapabilities
public final boolean hasCapabilities()For responses, this returns true if the service returned a value for the Capabilities 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. -
capabilities
A list of capabilities that the scene uses to render.
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
hasCapabilities()
method.- Returns:
- A list of capabilities that the scene uses to render.
-
hasSceneMetadata
public final boolean hasSceneMetadata()For responses, this returns true if the service returned a value for the SceneMetadata 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. -
sceneMetadata
The response metadata.
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
hasSceneMetadata()
method.- Returns:
- The response metadata.
-
hasGeneratedSceneMetadata
public final boolean hasGeneratedSceneMetadata()For responses, this returns true if the service returned a value for the GeneratedSceneMetadata 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. -
generatedSceneMetadata
The generated scene metadata.
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
hasGeneratedSceneMetadata()
method.- Returns:
- The generated scene metadata.
-
error
The SceneResponse error.
- Returns:
- The SceneResponse 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<GetSceneResponse.Builder,
GetSceneResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-