Package software.amazon.awssdk.codegen.poet.client.specs

Interface ProtocolSpec

All Known Implementing Classes:
Ec2ProtocolSpec, JsonProtocolSpec, QueryProtocolSpec, XmlProtocolSpec
public interface ProtocolSpec

  • Method Details

    • protocolFactory

      com.squareup.javapoet.FieldSpec protocolFactory(IntermediateModel model)

    • initProtocolFactory

      com.squareup.javapoet.MethodSpec initProtocolFactory(IntermediateModel model)

    • responseHandler

      com.squareup.javapoet.CodeBlock responseHandler(IntermediateModel model, OperationModel opModel)

    • errorResponseHandler

      Optional<com.squareup.javapoet.CodeBlock> errorResponseHandler(OperationModel opModel)

    • executionHandler

      com.squareup.javapoet.CodeBlock executionHandler(OperationModel opModel)

    • asyncExecutionHandler

      default com.squareup.javapoet.CodeBlock asyncExecutionHandler(IntermediateModel intermediateModel, OperationModel opModel)
      Execution handler invocation only differs for protocols that support streaming outputs (REST-JSON, REST-XML).

    • getClientHandlerClass

      default Class<? extends SyncClientHandler> getClientHandlerClass()

    • createErrorResponseHandler

      Optional<com.squareup.javapoet.MethodSpec> createErrorResponseHandler()

    • additionalMethods

      default List<com.squareup.javapoet.MethodSpec> additionalMethods()

    • registerModeledExceptions

      default List<com.squareup.javapoet.CodeBlock> registerModeledExceptions(IntermediateModel model, PoetExtension poetExtensions)

    • populateHttpStatusCode

      default String populateHttpStatusCode(ShapeModel shapeModel, IntermediateModel model)

    • hostPrefixExpression

      default String hostPrefixExpression(OperationModel opModel)

    • discoveredEndpoint

      default String discoveredEndpoint(OperationModel opModel)

    • credentialType

      default com.squareup.javapoet.CodeBlock credentialType(OperationModel opModel, IntermediateModel model)

    • syncStreamingMarshaller

      default com.squareup.javapoet.CodeBlock syncStreamingMarshaller(IntermediateModel model, OperationModel opModel, com.squareup.javapoet.ClassName marshaller)
      For sync streaming operations, wrap request marshaller in StreamingRequestMarshaller class.

    • asyncMarshaller

      default com.squareup.javapoet.CodeBlock asyncMarshaller(IntermediateModel model, OperationModel opModel, com.squareup.javapoet.ClassName marshaller, String protocolFactory)

    • streamingMarshallerCode

      default com.squareup.javapoet.CodeBlock streamingMarshallerCode(IntermediateModel model, OperationModel opModel, com.squareup.javapoet.ClassName marshaller, String protocolFactory, boolean isAsync)

    • streamingOutputWhenComplete

      default String streamingOutputWhenComplete(String responseHandlerName)
      Need to notify the response handler/response transformer if the future is completed exceptionally.
      Parameters:
      responseHandlerName - Variable name of response handler customer passed in.
      Returns:
      whenComplete to append to future.

    • executeFutureValueType

      default com.squareup.javapoet.TypeName executeFutureValueType(OperationModel opModel, PoetExtension poetExtensions)

    • getPojoResponseType

      default com.squareup.javapoet.TypeName getPojoResponseType(OperationModel opModel, PoetExtension poetExtensions)
      Gets the POJO response type for the operation.
      Parameters:
      opModel - Operation to get response type for.

    • publishMetricsWhenComplete

      default String publishMetricsWhenComplete()

    • publishMetrics

      default String publishMetrics()