@Generated(value="software.amazon.awssdk:codegen") public 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.
Modifier and Type | Class and Description |
---|---|
static interface |
ImportApiKeysRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ByteBuffer |
body()
The payload of the POST request to import API keys.
|
static ImportApiKeysRequest.Builder |
builder() |
boolean |
equals(Object obj) |
Boolean |
failOnWarnings()
A query parameter to indicate whether to rollback ApiKey importation (
true ) or not (
false ) when error is encountered. |
ApiKeysFormat |
format()
A query parameter to specify the input format to imported API keys.
|
String |
formatString()
A query parameter to specify the input format to imported API keys.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
static Class<? extends ImportApiKeysRequest.Builder> |
serializableBuilderClass() |
ImportApiKeysRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public ByteBuffer body()
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
This method will return a new read-only ByteBuffer
each time it is invoked.
public 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
formatString()
.
csv
format is supported.ApiKeysFormat
public String formatString()
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
formatString()
.
csv
format is supported.ApiKeysFormat
public Boolean failOnWarnings()
A query parameter to indicate whether to rollback ApiKey importation (true
) or not (
false
) when error is encountered.
true
) or not (
false
) when error is encountered.public ImportApiKeysRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>
toBuilder
in class APIGatewayRequest
public static ImportApiKeysRequest.Builder builder()
public static Class<? extends ImportApiKeysRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.