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

Class ImportApiKeysRequest

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

The POST request to import API keys from an external source, such as a CSV-formatted file.

  • Method Details

    • body

      public final SdkBytes body()

      The payload of the POST request to import API keys. For the payload format, see API Key File Format.

      Returns:
      The payload of the POST request to import API keys. For the payload format, see API Key File Format.

    • format

      public final ApiKeysFormat format()

      A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

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

      Returns:
      A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
      See Also:

    • formatAsString

      public final String formatAsString()

      A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

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

      Returns:
      A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
      See Also:

    • failOnWarnings

      public final Boolean failOnWarnings()

      A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

      Returns:
      A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

    • toBuilder

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

    • builder

      public static ImportApiKeysRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportApiKeysRequest.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