Package software.amazon.awssdk.services.iottwinmaker.model

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>

  • Method Details

    • 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 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.

    • 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 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()

      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 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.

    • 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:
      toBuilder in interface ToCopyableBuilder<CreateSceneRequest.Builder,CreateSceneRequest>
      Specified by:
      toBuilder in class IoTTwinMakerRequest

    • builder

      public static CreateSceneRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateSceneRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo