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(value="software.amazon.awssdk:codegen")
public final class CreateSceneRequest
extends IoTTwinMakerRequest
implements ToCopyableBuilder<CreateSceneRequest.Builder,CreateSceneRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateSceneRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateSceneRequest.Builder	builder()
List<String>	capabilities() A list of capabilities that the scene uses to render itself.
String	contentLocation() The relative path that specifies the location of the content definition file.
String	description() The description for this scene.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapabilities() For responses, this returns true if the service returned a value for the Capabilities property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	sceneId() The ID of the scene.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSceneRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata that you can use to manage the scene.
CreateSceneRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workspaceId() 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

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.

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.

sceneId

public final String sceneId()

The ID of the scene.

Returns:

The ID of the scene.

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.

workspaceId

public final String workspaceId()

The ID of the workspace that contains the scene.

Returns:

The ID of the workspace that contains the scene.

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