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

Class ImportApiKeysRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.ImportApiKeysRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>

@Generated("software.amazon.awssdk:codegen")
public class ImportApiKeysRequest
extends AmazonWebServiceRequest
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	Description
static interface	ImportApiKeysRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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.
String	format()	A query parameter to specify the input format to imported API keys.
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer . Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

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

format

public String format()

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

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>

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