CreateSceneRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.iottwinmaker.model

Class CreateSceneRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iottwinmaker.model.CreateSceneRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSceneRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateSceneRequest ()

Constructors
Constructor and Description
`CreateSceneRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateSceneRequest`	`addSceneMetadataEntry (String key, String value)` Add a single SceneMetadata entry
`CreateSceneRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CreateSceneRequest`	`clearSceneMetadataEntries ()` Removes all the entries added into SceneMetadata.
`CreateSceneRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CreateSceneRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`List<String>`	`getCapabilities ()` A list of capabilities that the scene uses to render itself.
`String`	`getContentLocation ()` The relative path that specifies the location of the content definition file.
`String`	`getDescription ()` The description for this scene.
`String`	`getSceneId ()` The ID of the scene.
`Map<String,String>`	`getSceneMetadata ()` The request metadata.
`Map<String,String>`	`getTags ()` Metadata that you can use to manage the scene.
`String`	`getWorkspaceId ()` The ID of the workspace that contains the scene.
`int`	`hashCode ()`
`void`	`setCapabilities (Collection<String> capabilities)` A list of capabilities that the scene uses to render itself.
`void`	`setContentLocation (String contentLocation)` The relative path that specifies the location of the content definition file.
`void`	`setDescription (String description)` The description for this scene.
`void`	`setSceneId (String sceneId)` The ID of the scene.
`void`	`setSceneMetadata (Map<String,String> sceneMetadata)` The request metadata.
`void`	`setTags (Map<String,String> tags)` Metadata that you can use to manage the scene.
`void`	`setWorkspaceId (String workspaceId)` The ID of the workspace that contains the scene.
`String`	`toString ()` Returns a string representation of this object.
`CreateSceneRequest`	`withCapabilities (Collection<String> capabilities)` A list of capabilities that the scene uses to render itself.
`CreateSceneRequest`	`withCapabilities (String... capabilities)` A list of capabilities that the scene uses to render itself.
`CreateSceneRequest`	`withContentLocation (String contentLocation)` The relative path that specifies the location of the content definition file.
`CreateSceneRequest`	`withDescription (String description)` The description for this scene.
`CreateSceneRequest`	`withSceneId (String sceneId)` The ID of the scene.
`CreateSceneRequest`	`withSceneMetadata (Map<String,String> sceneMetadata)` The request metadata.
`CreateSceneRequest`	`withTags (Map<String,String> tags)` Metadata that you can use to manage the scene.
`CreateSceneRequest`	`withWorkspaceId (String workspaceId)` The ID of the workspace that contains the scene.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateSceneRequest
```
public CreateSceneRequest()
```
- Method Detail
  - setWorkspaceId
```
public void setWorkspaceId(String workspaceId)
```
    The ID of the workspace that contains the scene.
    
    Parameters:
    
    workspaceId - The ID of the workspace that contains the scene.
  - getWorkspaceId
```
public String getWorkspaceId()
```
    The ID of the workspace that contains the scene.
    
    Returns:
    
    The ID of the workspace that contains the scene.
  - withWorkspaceId
```
public CreateSceneRequest withWorkspaceId(String workspaceId)
```
    The ID of the workspace that contains the scene.
    
    Parameters:
    
    workspaceId - The ID of the workspace that contains the scene.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSceneId
```
public void setSceneId(String sceneId)
```
    The ID of the scene.
    
    Parameters:
    
    sceneId - The ID of the scene.
  - getSceneId
```
public String getSceneId()
```
    The ID of the scene.
    
    Returns:
    
    The ID of the scene.
  - withSceneId
```
public CreateSceneRequest withSceneId(String sceneId)
```
    The ID of the scene.
    
    Parameters:
    
    sceneId - The ID of the scene.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentLocation
```
public void setContentLocation(String contentLocation)
```
    The relative path that specifies the location of the content definition file.
    
    Parameters:
    
    contentLocation - The relative path that specifies the location of the content definition file.
  - getContentLocation
```
public String getContentLocation()
```
    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.
  - withContentLocation
```
public CreateSceneRequest withContentLocation(String contentLocation)
```
    The relative path that specifies the location of the content definition file.
    
    Parameters:
    
    contentLocation - The relative path that specifies the location of the content definition file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for this scene.
    
    Parameters:
    
    description - The description for this scene.
  - getDescription
```
public String getDescription()
```
    The description for this scene.
    
    Returns:
    
    The description for this scene.
  - withDescription
```
public CreateSceneRequest withDescription(String description)
```
    The description for this scene.
    
    Parameters:
    
    description - The description for this scene.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCapabilities
```
public List<String> getCapabilities()
```
    A list of capabilities that the scene uses to render itself.
    
    Returns:
    
    A list of capabilities that the scene uses to render itself.
  - setCapabilities
```
public void setCapabilities(Collection<String> capabilities)
```
    A list of capabilities that the scene uses to render itself.
    
    Parameters:
    
    capabilities - A list of capabilities that the scene uses to render itself.
  - withCapabilities
```
public CreateSceneRequest withCapabilities(String... capabilities)
```
    A list of capabilities that the scene uses to render itself.
    
    NOTE: This method appends the values to the existing list (if any). Use setCapabilities(java.util.Collection) or withCapabilities(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    capabilities - A list of capabilities that the scene uses to render itself.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCapabilities
```
public CreateSceneRequest withCapabilities(Collection<String> capabilities)
```
    A list of capabilities that the scene uses to render itself.
    
    Parameters:
    
    capabilities - A list of capabilities that the scene uses to render itself.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Metadata that you can use to manage the scene.
    
    Returns:
    
    Metadata that you can use to manage the scene.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Metadata that you can use to manage the scene.
    
    Parameters:
    
    tags - Metadata that you can use to manage the scene.
  - withTags
```
public CreateSceneRequest withTags(Map<String,String> tags)
```
    Metadata that you can use to manage the scene.
    
    Parameters:
    
    tags - Metadata that you can use to manage the scene.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateSceneRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateSceneRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSceneMetadata
```
public Map<String,String> getSceneMetadata()
```
    The request metadata.
    
    Returns:
    
    The request metadata.
  - setSceneMetadata
```
public void setSceneMetadata(Map<String,String> sceneMetadata)
```
    The request metadata.
    
    Parameters:
    
    sceneMetadata - The request metadata.
  - withSceneMetadata
```
public CreateSceneRequest withSceneMetadata(Map<String,String> sceneMetadata)
```
    The request metadata.
    
    Parameters:
    
    sceneMetadata - The request metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSceneMetadataEntry
```
public CreateSceneRequest addSceneMetadataEntry(String key,
 String value)
```
    Add a single SceneMetadata entry
    
    See Also:
    
    withSceneMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearSceneMetadataEntries
```
public CreateSceneRequest clearSceneMetadataEntries()
```
    Removes all the entries added into SceneMetadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateSceneRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateSceneRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateSceneRequest

Method Detail

setWorkspaceId

getWorkspaceId

withWorkspaceId

setSceneId

getSceneId

withSceneId

setContentLocation

getContentLocation

withContentLocation

setDescription

getDescription

withDescription

getCapabilities

setCapabilities

withCapabilities

withCapabilities

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getSceneMetadata

setSceneMetadata

withSceneMetadata

addSceneMetadataEntry

clearSceneMetadataEntries

toString

equals

hashCode

clone