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

Class ImportRestApiRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
software.amazon.awssdk.services.apigateway.model.ImportRestApiRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportRestApiRequest extends ApiGatewayRequest implements ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

A POST request to import an API to API Gateway using an input of an API definition file.

  • Method Details

    • failOnWarnings

      public final 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.

      Returns:
      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.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      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.

    • body

      public final 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.

      Returns:
      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.

    • toBuilder

      public ImportRestApiRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest

    • builder

      public static ImportRestApiRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportRestApiRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo