java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerResponse
    - - software.amazon.awssdk.services.iottwinmaker.model.GetEntityResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetEntityResponse.Builder,GetEntityResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetEntityResponse
extends IoTTwinMakerResponse
implements ToCopyableBuilder<GetEntityResponse.Builder,GetEntityResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetEntityResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`areAllComponentsReturned()`	This flag notes whether all components are returned in the API response.
`String`	`arn()`	The ARN of the entity.
`static GetEntityResponse.Builder`	`builder()`
`Map<String,ComponentResponse>`	`components()`	An object that maps strings to the components in the entity.
`Instant`	`creationDateTime()`	The date and time when the entity was created.
`String`	`description()`	The description of the entity.
`String`	`entityId()`	The ID of the entity.
`String`	`entityName()`	The name of the entity.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Boolean`	`hasChildEntities()`	A Boolean value that specifies whether the entity has associated child entities.
`boolean`	`hasComponents()`	For responses, this returns true if the service returned a value for the Components property.
`int`	`hashCode()`
`String`	`parentEntityId()`	The ID of the parent entity for this entity.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetEntityResponse.Builder>`	`serializableBuilderClass()`
`Status`	`status()`	The current status of the entity.
`String`	`syncSource()`	The syncSource of the sync job, if this entity was created by a sync job.
`GetEntityResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updateDateTime()`	The date and time when the entity was last updated.
`String`	`workspaceId()`	The ID of the workspace.

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 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
  - entityId
```
public final String entityId()
```
    The ID of the entity.
    
    Returns:
    
    The ID of the entity.
  - entityName
```
public final String entityName()
```
    The name of the entity.
    
    Returns:
    
    The name of the entity.
  - arn
```
public final String arn()
```
    The ARN of the entity.
    
    Returns:
    
    The ARN of the entity.
  - status
```
public final Status status()
```
    The current status of the entity.
    
    Returns:
    
    The current status of the entity.
  - workspaceId
```
public final String workspaceId()
```
    The ID of the workspace.
    
    Returns:
    
    The ID of the workspace.
  - description
```
public final String description()
```
    The description of the entity.
    
    Returns:
    
    The description of the entity.
  - hasComponents
```
public final boolean hasComponents()
```
    For responses, this returns true if the service returned a value for the Components 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.
  - components
```
public final Map<String,ComponentResponse> components()
```
    An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
    
    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 hasComponents() method.
    
    Returns:
    
    An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
  - parentEntityId
```
public final String parentEntityId()
```
    The ID of the parent entity for this entity.
    
    Returns:
    
    The ID of the parent entity for this entity.
  - hasChildEntities
```
public final Boolean hasChildEntities()
```
    A Boolean value that specifies whether the entity has associated child entities.
    
    Returns:
    
    A Boolean value that specifies whether the entity has associated child entities.
  - creationDateTime
```
public final Instant creationDateTime()
```
    The date and time when the entity was created.
    
    Returns:
    
    The date and time when the entity was created.
  - updateDateTime
```
public final Instant updateDateTime()
```
    The date and time when the entity was last updated.
    
    Returns:
    
    The date and time when the entity was last updated.
  - syncSource
```
public final String syncSource()
```
    The syncSource of the sync job, if this entity was created by a sync job.
    
    Returns:
    
    The syncSource of the sync job, if this entity was created by a sync job.
  - areAllComponentsReturned
```
public final Boolean areAllComponentsReturned()
```
    This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
    
    Returns:
    
    This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
  - toBuilder
```
public GetEntityResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetEntityResponse.Builder,GetEntityResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetEntityResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetEntityResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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 SdkResponse
  - 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

Class GetEntityResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

entityId

entityName

arn

status

workspaceId

description

hasComponents

components

parentEntityId

hasChildEntities

creationDateTime

updateDateTime

syncSource

areAllComponentsReturned

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField