Interface ImportRestApiRequest.Builder

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

  • Method Details

    • failOnWarnings

      ImportRestApiRequest.Builder failOnWarnings(Boolean failOnWarnings)

      A query parameter to indicate whether to rollback the API creation (true) or not ( false) when a warning is encountered. The default value is false.

      Parameters:
      failOnWarnings - A query parameter to indicate whether to rollback the API creation (true) or not ( false) when a warning is encountered. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ImportRestApiRequest.Builder parameters(Map<String,String> parameters)

      A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

      To exclude DocumentationParts from the import, set parameters as ignore=documentation.

      To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

      To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

      Parameters:
      parameters - A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

      To exclude DocumentationParts from the import, set parameters as ignore=documentation.

      To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

      To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      ImportRestApiRequest.Builder body(SdkBytes body)

      The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

      Parameters:
      body - The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ImportRestApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ImportRestApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.