java.lang.Object
- software.amazon.awssdk.services.iottwinmaker.model.EntityPropertyReference

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<EntityPropertyReference.Builder,EntityPropertyReference>

@Generated("software.amazon.awssdk:codegen")
public final class EntityPropertyReference
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EntityPropertyReference.Builder,EntityPropertyReference>

An object that uniquely identifies an entity property.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EntityPropertyReference.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EntityPropertyReference.Builder`	`builder()`
`String`	`componentName()`	The name of the component.
`String`	`componentPath()`	This string specifies the path to the composite component, starting from the top-level component.
`String`	`entityId()`	The ID of the entity.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Map<String,String>`	`externalIdProperty()`	A mapping of external IDs to property names.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExternalIdProperty()`	For responses, this returns true if the service returned a value for the ExternalIdProperty property.
`int`	`hashCode()`
`String`	`propertyName()`	The name of the property.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EntityPropertyReference.Builder>`	`serializableBuilderClass()`
`EntityPropertyReference.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - componentName
```
public final String componentName()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - componentPath
```
public final String componentPath()
```
    This string specifies the path to the composite component, starting from the top-level component.
    
    Returns:
    
    This string specifies the path to the composite component, starting from the top-level component.
  - hasExternalIdProperty
```
public final boolean hasExternalIdProperty()
```
    For responses, this returns true if the service returned a value for the ExternalIdProperty 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.
  - externalIdProperty
```
public final Map<String,String> externalIdProperty()
```
    A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
    
    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 hasExternalIdProperty() method.
    
    Returns:
    
    A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
  - entityId
```
public final String entityId()
```
    The ID of the entity.
    
    Returns:
    
    The ID of the entity.
  - propertyName
```
public final String propertyName()
```
    The name of the property.
    
    Returns:
    
    The name of the property.
  - toBuilder
```
public EntityPropertyReference.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EntityPropertyReference.Builder,EntityPropertyReference>
  - builder
```
public static EntityPropertyReference.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EntityPropertyReference.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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 EntityPropertyReference

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

componentName

componentPath

hasExternalIdProperty

externalIdProperty

entityId

propertyName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField