Class ImportDocumentationPartsRequest

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.ImportDocumentationPartsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportDocumentationPartsRequest extends ApiGatewayRequest implements ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

Import documentation parts from an external (e.g., OpenAPI) definition file.

  • Method Details

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • mode

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

      If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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

    • modeAsString

      public final String modeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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

    • failOnWarnings

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

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

    • body

      public final SdkBytes body()

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

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

    • toBuilder

      public ImportDocumentationPartsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static ImportDocumentationPartsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportDocumentationPartsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.