com.amazonaws.services.apigateway.model

Class CreateApiKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.CreateApiKeyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Request to create an ApiKey resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateApiKeyRequest()

Method Summary

Modifier and Type	Method and Description
CreateApiKeyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCustomerId() An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String	getDescription() The description of the ApiKey.
Boolean	getEnabled() Specifies whether the ApiKey can be used by callers.
Boolean	getGenerateDistinctId() Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
String	getName() The name of the ApiKey.
List<StageKey>	getStageKeys() DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
String	getValue() Specifies a value of the API key.
int	hashCode()
Boolean	isEnabled() Specifies whether the ApiKey can be used by callers.
Boolean	isGenerateDistinctId() Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
void	setCustomerId(String customerId) An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
void	setDescription(String description) The description of the ApiKey.
void	setEnabled(Boolean enabled) Specifies whether the ApiKey can be used by callers.
void	setGenerateDistinctId(Boolean generateDistinctId) Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
void	setName(String name) The name of the ApiKey.
void	setStageKeys(Collection<StageKey> stageKeys) DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
void	setValue(String value) Specifies a value of the API key.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateApiKeyRequest	withCustomerId(String customerId) An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
CreateApiKeyRequest	withDescription(String description) The description of the ApiKey.
CreateApiKeyRequest	withEnabled(Boolean enabled) Specifies whether the ApiKey can be used by callers.
CreateApiKeyRequest	withGenerateDistinctId(Boolean generateDistinctId) Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
CreateApiKeyRequest	withName(String name) The name of the ApiKey.
CreateApiKeyRequest	withStageKeys(Collection<StageKey> stageKeys) DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest	withStageKeys(StageKey... stageKeys) DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest	withValue(String value) Specifies a value of the API key.

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

CreateApiKeyRequest

public CreateApiKeyRequest()

Method Detail

setName

public void setName(String name)

The name of the ApiKey.

Parameters:

name - The name of the ApiKey.

getName

public String getName()

The name of the ApiKey.

Returns:

The name of the ApiKey.

withName

public CreateApiKeyRequest withName(String name)

The name of the ApiKey.

Parameters:

name - The name of the ApiKey.

Returns:

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

setDescription

public void setDescription(String description)

The description of the ApiKey.

Parameters:

description - The description of the ApiKey.

getDescription

public String getDescription()

The description of the ApiKey.

Returns:

The description of the ApiKey.

withDescription

public CreateApiKeyRequest withDescription(String description)

The description of the ApiKey.

Parameters:

description - The description of the ApiKey.

Returns:

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

setEnabled

public void setEnabled(Boolean enabled)

Specifies whether the ApiKey can be used by callers.

Parameters:

enabled - Specifies whether the ApiKey can be used by callers.

getEnabled

public Boolean getEnabled()

Specifies whether the ApiKey can be used by callers.

Returns:

Specifies whether the ApiKey can be used by callers.

withEnabled

public CreateApiKeyRequest withEnabled(Boolean enabled)

Specifies whether the ApiKey can be used by callers.

Parameters:

enabled - Specifies whether the ApiKey can be used by callers.

Returns:

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

isEnabled

public Boolean isEnabled()

Specifies whether the ApiKey can be used by callers.

Returns:

Specifies whether the ApiKey can be used by callers.

setGenerateDistinctId

public void setGenerateDistinctId(Boolean generateDistinctId)

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Parameters:

generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

getGenerateDistinctId

public Boolean getGenerateDistinctId()

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Returns:

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

withGenerateDistinctId

public CreateApiKeyRequest withGenerateDistinctId(Boolean generateDistinctId)

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Parameters:

generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Returns:

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

isGenerateDistinctId

public Boolean isGenerateDistinctId()

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Returns:

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

setValue

public void setValue(String value)

Specifies a value of the API key.

Parameters:

value - Specifies a value of the API key.

getValue

public String getValue()

Specifies a value of the API key.

Returns:

Specifies a value of the API key.

withValue

public CreateApiKeyRequest withValue(String value)

Specifies a value of the API key.

Parameters:

value - Specifies a value of the API key.

Returns:

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

getStageKeys

public List<StageKey> getStageKeys()

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

setStageKeys

public void setStageKeys(Collection<StageKey> stageKeys)

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

withStageKeys

public CreateApiKeyRequest withStageKeys(StageKey... stageKeys)

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

NOTE: This method appends the values to the existing list (if any). Use setStageKeys(java.util.Collection) or withStageKeys(java.util.Collection) if you want to override the existing values.

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:

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

withStageKeys

public CreateApiKeyRequest withStageKeys(Collection<StageKey> stageKeys)

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Parameters:

stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns:

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

setCustomerId

public void setCustomerId(String customerId)

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Parameters:

customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

getCustomerId

public String getCustomerId()

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Returns:

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

withCustomerId

public CreateApiKeyRequest withCustomerId(String customerId)

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Parameters:

customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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