com.amazonaws.services.apigateway.model

Class ImportApiKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.ImportApiKeysRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImportApiKeysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The POST request to import API keys from an external source, such as a CSV-formatted file.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ImportApiKeysRequest()

Method Summary

Modifier and Type	Method and Description
ImportApiKeysRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ByteBuffer	getBody() The payload of the POST request to import API keys.
Boolean	getFailOnWarnings() A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
String	getFormat() A query parameter to specify the input format to imported API keys.
int	hashCode()
Boolean	isFailOnWarnings() A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
void	setBody(ByteBuffer body) The payload of the POST request to import API keys.
void	setFailOnWarnings(Boolean failOnWarnings) A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
void	setFormat(ApiKeysFormat format) A query parameter to specify the input format to imported API keys.
void	setFormat(String format) A query parameter to specify the input format to imported API keys.
String	toString() Returns a string representation of this object.
ImportApiKeysRequest	withBody(ByteBuffer body) The payload of the POST request to import API keys.
ImportApiKeysRequest	withFailOnWarnings(Boolean failOnWarnings) A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
ImportApiKeysRequest	withFormat(ApiKeysFormat format) A query parameter to specify the input format to imported API keys.
ImportApiKeysRequest	withFormat(String format) A query parameter to specify the input format to imported API keys.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportApiKeysRequest

public ImportApiKeysRequest()

Method Detail

setBody

public void setBody(ByteBuffer body)

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

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

getBody

public ByteBuffer getBody()

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.

withBody

public ImportApiKeysRequest withBody(ByteBuffer body)

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

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFormat

public void setFormat(String format)

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

Parameters:

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

See Also:

ApiKeysFormat

getFormat

public String getFormat()

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

withFormat

public ImportApiKeysRequest withFormat(String format)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiKeysFormat

setFormat

public void setFormat(ApiKeysFormat format)

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

Parameters:

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

See Also:

ApiKeysFormat

withFormat

public ImportApiKeysRequest withFormat(ApiKeysFormat format)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiKeysFormat

setFailOnWarnings

public void setFailOnWarnings(Boolean failOnWarnings)

A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

Parameters:

failOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

getFailOnWarnings

public Boolean getFailOnWarnings()

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.

withFailOnWarnings

public ImportApiKeysRequest withFailOnWarnings(Boolean failOnWarnings)

A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

Parameters:

failOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

Returns:

Returns a reference to this object so that method calls can be chained together.

isFailOnWarnings

public Boolean isFailOnWarnings()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ImportApiKeysRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()