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

Interface ImportDocumentationPartsRequest.Builder

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

  • Method Details

    • restApiId

      ImportDocumentationPartsRequest.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.

    • mode

      ImportDocumentationPartsRequest.Builder mode(String mode)

      A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

      Parameters:
      mode - A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      ImportDocumentationPartsRequest.Builder mode(PutMode mode)

      A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

      Parameters:
      mode - A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failOnWarnings

      ImportDocumentationPartsRequest.Builder failOnWarnings(Boolean failOnWarnings)

      A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered. The default value is false.

      Parameters:
      failOnWarnings - A query parameter to specify whether to rollback the documentation importation (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.

    • body

      ImportDocumentationPartsRequest.Builder body(SdkBytes body)

      Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

      Parameters:
      body - Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ImportDocumentationPartsRequest.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

      ImportDocumentationPartsRequest.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.