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()
      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<ImportApiKeysRequest.Builder,ImportApiKeysRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • 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)
      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.