Package software.amazon.awssdk.codegen.model.intermediate

Class OperationModel

java.lang.Object

software.amazon.awssdk.codegen.model.intermediate.DocumentationModel

software.amazon.awssdk.codegen.model.intermediate.OperationModel

public class OperationModel
extends DocumentationModel

Field Summary

Fields inherited from class software.amazon.awssdk.codegen.model.intermediate.DocumentationModel

documentation

Constructor Summary

Constructors

Constructor	Description
OperationModel()

Method Summary

Modifier and Type	Method	Description
void	addException(ExceptionModel exception)
void	addSimpleMethodForm(List<ArgumentModel> arguments)
List<AuthType>	getAuth()
AuthType	getAuthType()
String	getDeprecatedMessage()
String	getDocs(IntermediateModel model, ClientType clientType)
String	getDocs(IntermediateModel model, ClientType clientType, SimpleMethodOverload methodOverload)
String	getDocs(IntermediateModel model, ClientType clientType, SimpleMethodOverload methodOverload, DocConfiguration config)
EndpointDiscovery	getEndpointDiscovery()
EndpointTrait	getEndpointTrait()	Returns the endpoint trait that will be used to resolve the endpoint of an API.
List<ExceptionModel>	getExceptions()
boolean	getHasBlobMemberAsPayload()
boolean	getHasStringMemberAsPayload()
HttpChecksum	getHttpChecksum()
VariableModel	getInput()
ShapeModel	getInputShape()
String	getMethodName()
String	getOperationName()
ShapeModel	getOutputShape()
RequestCompression	getRequestCompression()
ReturnTypeModel	getReturnType()
String	getServiceProtocol()
List<SimpleMethodFormModel>	getSimpleMethodForms()
Map<String,StaticContextParam>	getStaticContextParams()
String	getSyncReturnType()
boolean	hasEventStreamInput()
boolean	hasEventStreamOutput()
boolean	hasRequiresLengthInInput()
boolean	hasStreamingInput()
boolean	hasStreamingOutput()
boolean	isAuthenticated()
boolean	isDeprecated()
boolean	isEndpointCacheRequired()
boolean	isEndpointOperation()
boolean	isHttpChecksumRequired()
boolean	isPaginated()
boolean	isStreaming()
void	setAuth(List<AuthType> auth)
void	setAuthType(AuthType authType)
void	setDeprecated(boolean deprecated)
void	setDeprecatedMessage(String deprecatedMessage)
void	setEndpointCacheRequired(boolean endpointCacheRequired)
void	setEndpointDiscovery(EndpointDiscovery endpointDiscovery)
void	setEndpointOperation(boolean endpointOperation)
void	setEndpointTrait(EndpointTrait endpointTrait)	Sets the endpoint trait that will be used to resolve the endpoint of an API.
void	setExceptions(List<ExceptionModel> exceptions)
void	setHasBlobMemberAsPayload(boolean hasBlobMemberAsPayload)
void	setHasStringMemberAsPayload(boolean hasStringMemberAsPayload)
void	setHttpChecksum(HttpChecksum httpChecksum)
void	setHttpChecksumRequired(boolean httpChecksumRequired)
void	setInput(VariableModel input)
void	setInputShape(ShapeModel inputShape)
void	setIsAuthenticated(boolean isAuthenticated)
void	setOperationName(String operationName)
void	setOutputShape(ShapeModel outputShape)
void	setPaginated(boolean paginated)
void	setRequestCompression(RequestCompression requestCompression)
void	setReturnType(ReturnTypeModel returnType)
void	setServiceProtocol(String serviceProtocol)
void	setStaticContextParams(Map<String,StaticContextParam> staticContextParams)

Methods inherited from class software.amazon.awssdk.codegen.model.intermediate.DocumentationModel

getDocumentation, setDocumentation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OperationModel

public OperationModel()

Method Detail

getOperationName

public String getOperationName()

setOperationName

public void setOperationName(String operationName)

getMethodName

public String getMethodName()

getServiceProtocol

public String getServiceProtocol()

setServiceProtocol

public void setServiceProtocol(String serviceProtocol)

isDeprecated

public boolean isDeprecated()

setDeprecated

public void setDeprecated(boolean deprecated)

getDeprecatedMessage

public String getDeprecatedMessage()

setDeprecatedMessage

public void setDeprecatedMessage(String deprecatedMessage)

getDocs

public String getDocs(IntermediateModel model,
                      ClientType clientType)

getDocs

public String getDocs(IntermediateModel model,
                      ClientType clientType,
                      SimpleMethodOverload methodOverload)

getDocs

public String getDocs(IntermediateModel model,
                      ClientType clientType,
                      SimpleMethodOverload methodOverload,
                      DocConfiguration config)

isAuthenticated

public boolean isAuthenticated()

setIsAuthenticated

public void setIsAuthenticated(boolean isAuthenticated)

getAuthType

public AuthType getAuthType()

setAuthType

public void setAuthType(AuthType authType)

getAuth

public List<AuthType> getAuth()

setAuth

public void setAuth(List<AuthType> auth)

getInputShape

public ShapeModel getInputShape()

setInputShape

public void setInputShape(ShapeModel inputShape)

getOutputShape

public ShapeModel getOutputShape()

setOutputShape

public void setOutputShape(ShapeModel outputShape)

getInput

public VariableModel getInput()

setInput

public void setInput(VariableModel input)

getReturnType

public ReturnTypeModel getReturnType()

setReturnType

public void setReturnType(ReturnTypeModel returnType)

getSyncReturnType

public String getSyncReturnType()

getExceptions

public List<ExceptionModel> getExceptions()

setExceptions

public void setExceptions(List<ExceptionModel> exceptions)

addException

public void addException(ExceptionModel exception)

getSimpleMethodForms

public List<SimpleMethodFormModel> getSimpleMethodForms()

addSimpleMethodForm

public void addSimpleMethodForm(List<ArgumentModel> arguments)

getHasBlobMemberAsPayload

public boolean getHasBlobMemberAsPayload()

setHasBlobMemberAsPayload

public void setHasBlobMemberAsPayload(boolean hasBlobMemberAsPayload)

getHasStringMemberAsPayload

public boolean getHasStringMemberAsPayload()

setHasStringMemberAsPayload

public void setHasStringMemberAsPayload(boolean hasStringMemberAsPayload)

hasStreamingInput

public boolean hasStreamingInput()

hasStreamingOutput

public boolean hasStreamingOutput()

isStreaming

public boolean isStreaming()

isEndpointOperation

public boolean isEndpointOperation()

setEndpointOperation

public void setEndpointOperation(boolean endpointOperation)

isEndpointCacheRequired

public boolean isEndpointCacheRequired()

setEndpointCacheRequired

public void setEndpointCacheRequired(boolean endpointCacheRequired)

isPaginated

public boolean isPaginated()

setPaginated

public void setPaginated(boolean paginated)

getEndpointDiscovery

public EndpointDiscovery getEndpointDiscovery()

setEndpointDiscovery

public void setEndpointDiscovery(EndpointDiscovery endpointDiscovery)

getEndpointTrait

public EndpointTrait getEndpointTrait()

Returns the endpoint trait that will be used to resolve the endpoint of an API.

setEndpointTrait

public void setEndpointTrait(EndpointTrait endpointTrait)

Sets the endpoint trait that will be used to resolve the endpoint of an API.

hasEventStreamOutput

public boolean hasEventStreamOutput()

Returns:

True if the operation has an event stream member in the output shape. False otherwise.

hasEventStreamInput

public boolean hasEventStreamInput()

Returns:

True if the operation has an event stream member in the input shape. False otherwise.

hasRequiresLengthInInput

public boolean hasRequiresLengthInInput()

isHttpChecksumRequired

public boolean isHttpChecksumRequired()

setHttpChecksumRequired

public void setHttpChecksumRequired(boolean httpChecksumRequired)

getHttpChecksum

public HttpChecksum getHttpChecksum()

setHttpChecksum

public void setHttpChecksum(HttpChecksum httpChecksum)

getRequestCompression

public RequestCompression getRequestCompression()

setRequestCompression

public void setRequestCompression(RequestCompression requestCompression)

getStaticContextParams

public Map<String,StaticContextParam> getStaticContextParams()

setStaticContextParams

public void setStaticContextParams(Map<String,StaticContextParam> staticContextParams)