Package software.amazon.awssdk.services.apigateway.model

Interface TestInvokeMethodRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>, SdkBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
TestInvokeMethodRequest
@Mutable @NotThreadSafe public static interface TestInvokeMethodRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>

  • Method Details

    • restApiId

      TestInvokeMethodRequest.Builder restApiId(String restApiId)

      The string identifier of the associated RestApi.

      Parameters:
      restApiId - The string identifier of the associated RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceId

      TestInvokeMethodRequest.Builder resourceId(String resourceId)

      Specifies a test invoke method request's resource ID.

      Parameters:
      resourceId - Specifies a test invoke method request's resource ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpMethod

      TestInvokeMethodRequest.Builder httpMethod(String httpMethod)

      Specifies a test invoke method request's HTTP method.

      Parameters:
      httpMethod - Specifies a test invoke method request's HTTP method.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pathWithQueryString

      TestInvokeMethodRequest.Builder pathWithQueryString(String pathWithQueryString)

      The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

      Parameters:
      pathWithQueryString - The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      TestInvokeMethodRequest.Builder body(String body)

      The simulated request body of an incoming invocation request.

      Parameters:
      body - The simulated request body of an incoming invocation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      TestInvokeMethodRequest.Builder headers(Map<String,String> headers)

      A key-value map of headers to simulate an incoming invocation request.

      Parameters:
      headers - A key-value map of headers to simulate an incoming invocation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiValueHeaders

      TestInvokeMethodRequest.Builder multiValueHeaders(Map<String,? extends Collection<String>> multiValueHeaders)

      The headers as a map from string to list of values to simulate an incoming invocation request.

      Parameters:
      multiValueHeaders - The headers as a map from string to list of values to simulate an incoming invocation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientCertificateId

      TestInvokeMethodRequest.Builder clientCertificateId(String clientCertificateId)

      A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

      Parameters:
      clientCertificateId - A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageVariables

      TestInvokeMethodRequest.Builder stageVariables(Map<String,String> stageVariables)

      A key-value map of stage variables to simulate an invocation on a deployed Stage.

      Parameters:
      stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      TestInvokeMethodRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      TestInvokeMethodRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder