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

Interface GetExportRequest.Builder

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

  • Method Details

    • restApiId

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

    • stageName

      GetExportRequest.Builder stageName(String stageName)

      The name of the Stage that will be exported.

      Parameters:
      stageName - The name of the Stage that will be exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportType

      GetExportRequest.Builder exportType(String exportType)

      The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

      Parameters:
      exportType - The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

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

      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

      Parameters:
      parameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accepts

      GetExportRequest.Builder accepts(String accepts)

      The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of oas30 and swagger. This should be specified in the Accept header for direct API requests.

      Parameters:
      accepts - The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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