Class CreateSceneRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest
-
- software.amazon.awssdk.services.iottwinmaker.model.CreateSceneRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateSceneRequest.Builder,CreateSceneRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSceneRequest extends IoTTwinMakerRequest implements ToCopyableBuilder<CreateSceneRequest.Builder,CreateSceneRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateSceneRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateSceneRequest.Builderbuilder()List<String>capabilities()A list of capabilities that the scene uses to render itself.StringcontentLocation()The relative path that specifies the location of the content definition file.Stringdescription()The description for this scene.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCapabilities()For responses, this returns true if the service returned a value for the Capabilities property.inthashCode()booleanhasSceneMetadata()For responses, this returns true if the service returned a value for the SceneMetadata property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringsceneId()The ID of the scene.Map<String,String>sceneMetadata()The request metadata.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateSceneRequest.Builder>serializableBuilderClass()Map<String,String>tags()Metadata that you can use to manage the scene.CreateSceneRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkspaceId()The ID of the workspace that contains the scene.-
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
-
workspaceId
public final String workspaceId()
The ID of the workspace that contains the scene.
- Returns:
- The ID of the workspace that contains the scene.
-
sceneId
public final String sceneId()
The ID of the scene.
- Returns:
- The ID of the scene.
-
contentLocation
public final String 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.
-
description
public final String description()
The description for this scene.
- Returns:
- The description for this 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
public final List<String> capabilities()
A list of capabilities that the scene uses to render itself.
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 itself.
-
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
public final Map<String,String> tags()
Metadata that you can use to manage the scene.
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:
- Metadata that you can use to manage the scene.
-
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
public final Map<String,String> sceneMetadata()
The request 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 request metadata.
-
toBuilder
public CreateSceneRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateSceneRequest.Builder,CreateSceneRequest>- Specified by:
toBuilderin classIoTTwinMakerRequest
-
builder
public static CreateSceneRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateSceneRequest.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
-
-