Class ShapeModel
java.lang.Object
software.amazon.awssdk.codegen.model.intermediate.DocumentationModel
software.amazon.awssdk.codegen.model.intermediate.ShapeModel
- All Implemented Interfaces:
HasDeprecation
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addMember
(MemberModel member) boolean
findEnumModelByValue
(String enumValue) Returns the enum model for the given enum value.findMemberModelByC2jName
(String memberC2jName) Returns the member model associated with the given c2j member name from this shape model.getEnums()
Explicit event payload member will have "eventpayload" trait set to true.Return the httpStatusCode of the exception shape.getMemberByC2jName
(String memberName) getMemberByName
(String memberName) getMemberByVariableName
(String memberVariableName) getType()
int
hashCode()
boolean
boolean
boolean
If all members in shape have eventheader trait, then there is no payloadboolean
boolean
boolean
boolean
isEvent()
boolean
boolean
isFault()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isUnion()
boolean
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.void
setC2jName
(String c2jName) void
setCustomization
(ShapeCustomizationInfo customization) void
setDeprecated
(boolean deprecated) void
setDeprecatedMessage
(String deprecatedMessage) void
setEndpointDiscovery
(EndpointDiscovery endpointDiscovery) void
void
setErrorCode
(String errorCode) void
setHasHeaderMember
(boolean hasHeaderMember) void
setHasPayloadMember
(boolean hasPayloadMember) void
setHasRequiresLengthMember
(boolean hasRequiresLengthMember) void
setHasStatusCodeMember
(boolean hasStatusCodeMember) void
setHasStreamingMember
(boolean hasStreamingMember) void
setHttpStatusCode
(Integer httpStatusCode) void
setMarshaller
(ShapeMarshaller marshaller) void
setMembers
(List<MemberModel> members) void
setRequestSignerClassFqcn
(String authorizerClass) void
setRequired
(List<String> required) void
setShapeName
(String shapeName) void
setSimpleMethod
(boolean simpleMethod) void
void
void
setUnmarshaller
(ShapeUnmarshaller unmarshaller) void
setVariable
(VariableModel variable) void
setWrapper
(boolean wrapper) void
setXmlNamespace
(XmlNamespace xmlNamespace) toString()
tryFindMemberModelByC2jName
(String memberC2jName, boolean ignoreCase) Tries to find the member model associated with the given c2j member name from this shape model.withHasHeaderMember
(boolean hasHeaderMember) withHasPayloadMember
(boolean hasPayloadMember) withHasRequiresLengthMember
(boolean hasRequiresLengthMember) withHasStatusCodeMember
(boolean hasStatusCodeMember) withHasStreamingMember
(boolean hasStreamingMember) withIsDocument
(boolean document) withIsEvent
(boolean isEvent) withIsEventStream
(boolean isEventStream) withIsFault
(boolean fault) withIsRetryable
(boolean retryable) withIsThrottling
(boolean throttling) void
withIsUnion
(boolean union) withXmlNamespace
(XmlNamespace xmlNamespace) Methods inherited from class software.amazon.awssdk.codegen.model.intermediate.DocumentationModel
getDocumentation, setDocumentation
-
Constructor Details
-
ShapeModel
public ShapeModel() -
ShapeModel
-
-
Method Details
-
getShapeName
-
setShapeName
-
isDeprecated
public boolean isDeprecated()- Specified by:
isDeprecated
in interfaceHasDeprecation
-
setDeprecated
public void setDeprecated(boolean deprecated) -
getDeprecatedMessage
-
setDeprecatedMessage
-
getC2jName
-
setC2jName
-
getType
-
setType
-
setType
-
getShapeType
-
withType
-
getRequired
-
setRequired
-
isHasPayloadMember
public boolean isHasPayloadMember() -
setHasPayloadMember
public void setHasPayloadMember(boolean hasPayloadMember) -
withHasPayloadMember
-
getPayloadMember
- Returns:
- The member explicitly designated as the payload member
-
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
- 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
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
-
isHasRequiresLengthMember
public boolean isHasRequiresLengthMember() -
setHasRequiresLengthMember
public void setHasRequiresLengthMember(boolean hasRequiresLengthMember) -
withHasRequiresLengthMember
-
isHasHeaderMember
public boolean isHasHeaderMember() -
setHasHeaderMember
public void setHasHeaderMember(boolean hasHeaderMember) -
withHasHeaderMember
-
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
-
getMemberByVariableName
-
getMemberByName
-
getMemberByC2jName
-
getMembers
-
getNonStreamingMembers
- Returns:
- All non-streaming members of the shape.
-
setMembers
-
addMember
-
getEnums
-
setEnums
-
addEnum
-
getVariable
-
setVariable
-
getMarshaller
-
setMarshaller
-
getUnmarshaller
-
setUnmarshaller
-
getCustomization
-
setCustomization
-
getMembersAsMap
-
tryFindMemberModelByC2jName
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
Returns the member model associated with the given c2j member name from this shape model. -
removeMemberByC2jName
Takes in the c2j member name as input and removes if the shape contains a member with the given name. Return false otherwise. -
findEnumModelByValue
-
getDocumentationShapeName
-
getUnionTypeGetterDocumentation
-
toString
-
getErrorCode
-
setErrorCode
-
getHttpStatusCode
Return the httpStatusCode of the exception shape. This value is present only for modeled exceptions. -
setHttpStatusCode
-
isRequestSignerAware
public boolean isRequestSignerAware() -
getRequestSignerClassFqcn
-
setRequestSignerClassFqcn
-
getEndpointDiscovery
-
setEndpointDiscovery
-
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
-
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
-
getXmlNamespace
-
withXmlNamespace
-
setXmlNamespace
-
isDocument
public boolean isDocument() -
withIsDocument
-
isUnion
public boolean isUnion() -
withIsUnion
public void withIsUnion(boolean union) -
isFault
public boolean isFault() -
withIsFault
-
isRetryable
public boolean isRetryable() -
withIsRetryable
-
isThrottling
public boolean isThrottling() -
withIsThrottling
-
equals
- Overrides:
equals
in classDocumentationModel
-
hashCode
public int hashCode()- Overrides:
hashCode
in classDocumentationModel
-