Class GetEntityResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetEntityResponse.Builder,
GetEntityResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
This flag notes whether all components are returned in the API response.final String
arn()
The ARN of the entity.static GetEntityResponse.Builder
builder()
final Map
<String, ComponentResponse> An object that maps strings to the components in the entity.final Instant
The date and time when the entity was created.final String
The description of the entity.final String
entityId()
The ID of the entity.final String
The name of the entity.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final Boolean
A Boolean value that specifies whether the entity has associated child entities.final boolean
For responses, this returns true if the service returned a value for the Components property.final int
hashCode()
final String
The ID of the parent entity for this entity.static Class
<? extends GetEntityResponse.Builder> final Status
status()
The current status of the entity.final String
The syncSource of the sync job, if this entity was created by a sync job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The date and time when the entity was last updated.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
entityId
The ID of the entity.
- Returns:
- The ID of the entity.
-
entityName
The name of the entity.
- Returns:
- The name of the entity.
-
arn
The ARN of the entity.
- Returns:
- The ARN of the entity.
-
status
The current status of the entity.
- Returns:
- The current status of the entity.
-
workspaceId
The ID of the workspace.
- Returns:
- The ID of the workspace.
-
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 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. -
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
The ID of the parent entity for this entity.
- Returns:
- The ID of the parent entity for this entity.
-
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
The date and time when the entity was created.
- Returns:
- The date and time when the entity was created.
-
updateDateTime
The date and time when the entity was last updated.
- Returns:
- The date and time when the entity was last updated.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetEntityResponse.Builder,
GetEntityResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-