Interface ExportApiRequest.Builder

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

  • Method Details

    • apiId

      ExportApiRequest.Builder apiId(String apiId)

      The API identifier.

      Parameters:
      apiId - The API identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportVersion

      ExportApiRequest.Builder exportVersion(String exportVersion)

      The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

      Parameters:
      exportVersion - The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeExtensions

      ExportApiRequest.Builder includeExtensions(Boolean includeExtensions)

      Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

      Parameters:
      includeExtensions - Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputType

      ExportApiRequest.Builder outputType(String outputType)

      The output type of the exported definition file. Valid values are JSON and YAML.

      Parameters:
      outputType - The output type of the exported definition file. Valid values are JSON and YAML.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • specification

      ExportApiRequest.Builder specification(String specification)

      The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

      Parameters:
      specification - The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageName

      ExportApiRequest.Builder stageName(String stageName)

      The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

      Parameters:
      stageName - The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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