Class ShapeModel

java.lang.Object
software.amazon.awssdk.codegen.model.intermediate.DocumentationModel
software.amazon.awssdk.codegen.model.intermediate.ShapeModel
All Implemented Interfaces:
HasDeprecation
public class ShapeModel extends DocumentationModel implements HasDeprecation

  • Constructor Details

    • ShapeModel

      public ShapeModel()

    • ShapeModel

      public ShapeModel(String c2jName)

  • Method Details

    • getShapeName

      public String getShapeName()

    • setShapeName

      public void setShapeName(String shapeName)

    • isDeprecated

      public boolean isDeprecated()
      Specified by:
      isDeprecated in interface HasDeprecation

    • setDeprecated

      public void setDeprecated(boolean deprecated)

    • getDeprecatedMessage

      public String getDeprecatedMessage()

    • setDeprecatedMessage

      public void setDeprecatedMessage(String deprecatedMessage)

    • getC2jName

      public String getC2jName()

    • setC2jName

      public void setC2jName(String c2jName)

    • getType

      public String getType()

    • setType

      public void setType(ShapeType shapeType)

    • setType

      public void setType(String type)

    • getShapeType

      public ShapeType getShapeType()

    • withType

      public ShapeModel withType(String type)

    • getRequired

      public List<String> getRequired()

    • setRequired

      public void setRequired(List<String> required)

    • isHasPayloadMember

      public boolean isHasPayloadMember()

    • setHasPayloadMember

      public void setHasPayloadMember(boolean hasPayloadMember)

    • withHasPayloadMember

      public ShapeModel withHasPayloadMember(boolean hasPayloadMember)

    • getPayloadMember

      public MemberModel getPayloadMember()
      Returns:
      The member explicitly designated as the payload member

    • getUnboundMembers

      public List<MemberModel> getUnboundMembers()
      Returns:
      The list of members whose location is not specified. If no payload member is explicitly set then these members will appear in the payload

    • getUnboundEventMembers

      public List<MemberModel> getUnboundEventMembers()
      Returns:
      The list of members whose are not marked with either eventheader or eventpayload trait.

    • hasPayloadMembers

      public boolean hasPayloadMembers()
      Returns:
      True if the shape has an explicit payload member or implicit payload member(s).

    • hasImplicitPayloadMembers

      public boolean hasImplicitPayloadMembers()

    • hasImplicitEventPayloadMembers

      public boolean hasImplicitEventPayloadMembers()

    • getExplicitEventPayloadMember

      public MemberModel getExplicitEventPayloadMember()
      Explicit event payload member will have "eventpayload" trait set to true. There can be at most only one member that can be declared as explicit payload.
      Returns:
      the member that has the 'eventpayload' trait set to true. If none found, return null.

    • hasNoEventPayload

      public boolean hasNoEventPayload()
      If all members in shape have eventheader trait, then there is no payload

    • isHasStreamingMember

      public boolean isHasStreamingMember()

    • setHasStreamingMember

      public void setHasStreamingMember(boolean hasStreamingMember)

    • withHasStreamingMember

      public ShapeModel withHasStreamingMember(boolean hasStreamingMember)

    • isHasRequiresLengthMember

      public boolean isHasRequiresLengthMember()

    • setHasRequiresLengthMember

      public void setHasRequiresLengthMember(boolean hasRequiresLengthMember)

    • withHasRequiresLengthMember

      public ShapeModel withHasRequiresLengthMember(boolean hasRequiresLengthMember)

    • isHasHeaderMember

      public boolean isHasHeaderMember()

    • setHasHeaderMember

      public void setHasHeaderMember(boolean hasHeaderMember)

    • withHasHeaderMember

      public ShapeModel withHasHeaderMember(boolean hasHeaderMember)

    • isHasStatusCodeMember

      public boolean isHasStatusCodeMember()

    • setHasStatusCodeMember

      public void setHasStatusCodeMember(boolean hasStatusCodeMember)

    • isWrapper

      public boolean isWrapper()

    • setWrapper

      public void setWrapper(boolean wrapper)

    • isSimpleMethod

      public boolean isSimpleMethod()

    • setSimpleMethod

      public void setSimpleMethod(boolean simpleMethod)

    • withHasStatusCodeMember

      public ShapeModel withHasStatusCodeMember(boolean hasStatusCodeMember)

    • getMemberByVariableName

      public MemberModel getMemberByVariableName(String memberVariableName)

    • getMemberByName

      public MemberModel getMemberByName(String memberName)

    • getMemberByC2jName

      public MemberModel getMemberByC2jName(String memberName)

    • getMembers

      public List<MemberModel> getMembers()

    • getNonStreamingMembers

      public List<MemberModel> getNonStreamingMembers()
      Returns:
      All non-streaming members of the shape.

    • setMembers

      public void setMembers(List<MemberModel> members)

    • addMember

      public void addMember(MemberModel member)

    • getEnums

      public List<EnumModel> getEnums()

    • setEnums

      public void setEnums(List<EnumModel> enums)

    • addEnum

      public void addEnum(EnumModel enumModel)

    • getVariable

      public VariableModel getVariable()

    • setVariable

      public void setVariable(VariableModel variable)

    • getMarshaller

      public ShapeMarshaller getMarshaller()

    • setMarshaller

      public void setMarshaller(ShapeMarshaller marshaller)

    • getUnmarshaller

      public ShapeUnmarshaller getUnmarshaller()

    • setUnmarshaller

      public void setUnmarshaller(ShapeUnmarshaller unmarshaller)

    • getCustomization

      public ShapeCustomizationInfo getCustomization()

    • setCustomization

      public void setCustomization(ShapeCustomizationInfo customization)

    • getMembersAsMap

      public Map<String,MemberModel> getMembersAsMap()

    • tryFindMemberModelByC2jName

      public MemberModel tryFindMemberModelByC2jName(String memberC2jName, boolean ignoreCase)
      Tries to find the member model associated with the given c2j member name from this shape model. Returns the member model if present else returns null.

    • findMemberModelByC2jName

      public MemberModel findMemberModelByC2jName(String memberC2jName)
      Returns the member model associated with the given c2j member name from this shape model.

    • removeMemberByC2jName

      public boolean removeMemberByC2jName(String memberC2jName, boolean ignoreCase)
      Takes in the c2j member name as input and removes if the shape contains a member with the given name. Return false otherwise.

    • findEnumModelByValue

      public EnumModel findEnumModelByValue(String enumValue)
      Returns the enum model for the given enum value. Returns null if no such enum value exists.

    • getDocumentationShapeName

      public String getDocumentationShapeName()

    • getUnionTypeGetterDocumentation

      public String getUnionTypeGetterDocumentation()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getErrorCode

      public String getErrorCode()

    • setErrorCode

      public void setErrorCode(String errorCode)

    • getHttpStatusCode

      public Integer getHttpStatusCode()
      Return the httpStatusCode of the exception shape. This value is present only for modeled exceptions.

    • setHttpStatusCode

      public void setHttpStatusCode(Integer httpStatusCode)

    • isRequestSignerAware

      public boolean isRequestSignerAware()

    • getRequestSignerClassFqcn

      public String getRequestSignerClassFqcn()

    • setRequestSignerClassFqcn

      public void setRequestSignerClassFqcn(String authorizerClass)

    • getEndpointDiscovery

      public EndpointDiscovery getEndpointDiscovery()

    • setEndpointDiscovery

      public void setEndpointDiscovery(EndpointDiscovery endpointDiscovery)

    • isEventStream

      public boolean isEventStream()
      Returns:
      True if the shape is an 'eventstream' shape. The eventstream shape is the tagged union like container that holds individual 'events'.

    • withIsEventStream

      public ShapeModel withIsEventStream(boolean isEventStream)

    • isEvent

      public boolean isEvent()
      Returns:
      True if the shape is an 'event'. I.E. It is a member of the eventstream and represents one logical event that can be delivered on the event stream.

    • withIsEvent

      public ShapeModel withIsEvent(boolean isEvent)

    • getXmlNamespace

      public XmlNamespace getXmlNamespace()

    • withXmlNamespace

      public ShapeModel withXmlNamespace(XmlNamespace xmlNamespace)

    • setXmlNamespace

      public void setXmlNamespace(XmlNamespace xmlNamespace)

    • isDocument

      public boolean isDocument()

    • withIsDocument

      public ShapeModel withIsDocument(boolean document)

    • isUnion

      public boolean isUnion()

    • withIsUnion

      public void withIsUnion(boolean union)

    • isFault

      public boolean isFault()

    • withIsFault

      public ShapeModel withIsFault(boolean fault)

    • isRetryable

      public boolean isRetryable()

    • withIsRetryable

      public ShapeModel withIsRetryable(boolean retryable)

    • isThrottling

      public boolean isThrottling()

    • withIsThrottling

      public ShapeModel withIsThrottling(boolean throttling)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class DocumentationModel

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class DocumentationModel