Package software.amazon.smithy.aws.traits.tagging

Class TaggableTrait

java.lang.Object
software.amazon.smithy.model.traits.AbstractTrait
software.amazon.smithy.aws.traits.tagging.TaggableTrait
All Implemented Interfaces:
software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.model.shapes.ToShapeId, software.amazon.smithy.model.traits.Trait, software.amazon.smithy.utils.ToSmithyBuilder<TaggableTrait>
public final class TaggableTrait extends software.amazon.smithy.model.traits.AbstractTrait implements software.amazon.smithy.utils.ToSmithyBuilder<TaggableTrait>
Marks a resource shape as taggable for further model validation.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TaggableTrait.Builder
     
    static final class 
    TaggableTrait.Provider
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final software.amazon.smithy.model.shapes.ShapeId
    ID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static TaggableTrait.Builder
    builder()
     
    protected software.amazon.smithy.model.node.Node
    createNode()
     
    Optional<TaggableApiConfig>
    getApiConfig()
    Gets the TaggableApiConfig if the resource has its own APIs for tagging.
    boolean
    getDisableSystemTags()
    Gets a boolean indicating whether or not the service supports the resource carrying system tags.
    Optional<String>
    getProperty()
    Gets the name of the property that represents the tags on the resource, if any.
    TaggableTrait.Builder
    toBuilder()
     

    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 Details

    • ID

      public static final software.amazon.smithy.model.shapes.ShapeId ID

  • Method Details

    • getDisableSystemTags

      public boolean getDisableSystemTags()
      Gets a boolean indicating whether or not the service supports the resource carrying system tags.
      Returns:
      Returns true if the service does not support the resource carrying system tags.

    • getApiConfig

      public Optional<TaggableApiConfig> getApiConfig()
      Gets the TaggableApiConfig if the resource has its own APIs for tagging.
      Returns:
      the TaggableApiConfig for the resource.

    • getProperty

      public Optional<String> getProperty()
      Gets the name of the property that represents the tags on the resource, if any.
      Returns:
      the name of the property that represents the tags of the resource.

    • createNode

      protected software.amazon.smithy.model.node.Node createNode()
      Specified by:
      createNode in class software.amazon.smithy.model.traits.AbstractTrait

    • builder

      public static TaggableTrait.Builder builder()

    • toBuilder

      public TaggableTrait.Builder toBuilder()
      Specified by:
      toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<TaggableTrait>