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:

ToCopyableBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportApiKeysRequest.Builder

Method Summary

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	formatAsString() 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()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

body

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.

Returns:

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

format

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 formatAsString().

Returns:

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

See Also:

ApiKeysFormat

formatAsString

public 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:

ApiKeysFormat

failOnWarnings

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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