Class ImportApiKeysRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ImportApiKeysRequest.Builder,
ImportApiKeysRequest>
The POST request to import API keys from an external source, such as a CSV-formatted file.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal SdkBytes
body()
The payload of the POST request to import API keys.static ImportApiKeysRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
A query parameter to indicate whether to rollback ApiKey importation (true
) or not (false
) when error is encountered.final ApiKeysFormat
format()
A query parameter to specify the input format to imported API keys.final String
A query parameter to specify the input format to imported API keys.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
static Class
<? extends ImportApiKeysRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnApiKeysFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- A query parameter to specify the input format to imported API keys. Currently, only the
csv
format is supported. - See Also:
-
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 returnApiKeysFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- A query parameter to specify the input format to imported API keys. Currently, only the
csv
format is supported. - See Also:
-
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
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 interfaceToCopyableBuilder<ImportApiKeysRequest.Builder,
ImportApiKeysRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-