IdRefTrait (Smithy API 1.23.1)

java.lang.Object
- software.amazon.smithy.model.traits.AbstractTrait
- - software.amazon.smithy.model.traits.IdRefTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<IdRefTrait>
```
public final class IdRefTrait
extends AbstractTrait
implements ToSmithyBuilder<IdRefTrait>
```
Indicates that a string value must contain a valid shape ID.
failWhenMissing can be set to true to fail when the shape ID contained in a string shape cannot be found in the result set of the selector property. failWhenMissing defaults to false when not set.
The selector property is used to query the model for all shapes that match a shape selector. The value contained within the string shape targeted by this trait MUST match one of the shapes returns by the shape selector if failWhenMissing is set to true. selector defaults to "*" when not set.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IdRefTrait.Builder

static class IdRefTrait.Provider

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static IdRefTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`boolean`	`failWhenMissing()`
`java.util.Optional<java.lang.String>`	`getErrorMessage()`
`Selector`	`getSelector()`
`IdRefTrait.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait
equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

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

Methods inherited from interface software.amazon.smithy.model.traits.Trait
isSynthetic

- Field Detail
  - ID
```
public static final ShapeId ID
```
- Method Detail
  - getSelector
```
public Selector getSelector()
```
  - failWhenMissing
```
public boolean failWhenMissing()
```
  - getErrorMessage
```
public java.util.Optional<java.lang.String> getErrorMessage()
```
  - toBuilder
```
public IdRefTrait.Builder toBuilder()
```
    Description copied from interface: ToSmithyBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToSmithyBuilder<IdRefTrait>
    
    Returns:
    
    a builder for type T
  - createNode
```
protected Node createNode()
```
    Description copied from class: AbstractTrait
    
    The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.
    
    Specified by:
    
    createNode in class AbstractTrait
    
    Returns:
    
    Returns the trait as a node.
  - builder
```
public static IdRefTrait.Builder builder()
```