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

Interface PutRestApiRequest.Builder

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

  • Method Details

    • restApiId

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

      PutRestApiRequest.Builder mode(String mode)

      The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

      Parameters:
      mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      PutRestApiRequest.Builder mode(PutMode mode)

      The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

      Parameters:
      mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failOnWarnings

      PutRestApiRequest.Builder failOnWarnings(Boolean failOnWarnings)

      A query parameter to indicate whether to rollback the API update (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 update (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

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

      Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

      Parameters:
      parameters - Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • body

      PutRestApiRequest.Builder body(SdkBytes body)

      The PUT 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 PUT 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

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

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