Class CreateApiKeyRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.apigateway.model.CreateApiKeyRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
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 Description CreateApiKeyRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateApiKeyRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDescription()
The description of the ApiKey.Boolean
getEnabled()
Specifies whether the ApiKey can be used by callers.String
getName()
The name of the ApiKey.List<StageKey>
getStageKeys()
Specifies whether the ApiKey can be used by callers.int
hashCode()
Boolean
isEnabled()
Specifies whether the ApiKey can be used by callers.void
setDescription(String description)
The description of the ApiKey.void
setEnabled(Boolean enabled)
Specifies whether the ApiKey can be used by callers.void
setName(String name)
The name of the ApiKey.void
setStageKeys(Collection<StageKey> stageKeys)
Specifies whether the ApiKey can be used by callers.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreateApiKeyRequest
withDescription(String description)
The description of the ApiKey.CreateApiKeyRequest
withEnabled(Boolean enabled)
Specifies whether the ApiKey can be used by callers.CreateApiKeyRequest
withName(String name)
The name of the ApiKey.CreateApiKeyRequest
withStageKeys(StageKey... stageKeys)
Specifies whether the ApiKey can be used by callers.CreateApiKeyRequest
withStageKeys(Collection<StageKey> stageKeys)
Specifies whether the ApiKey can be used by callers.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setName
public void setName(String name)
The name of the ApiKey.
- Parameters:
name
- 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.
-
getStageKeys
public List<StageKey> getStageKeys()
Specifies whether the ApiKey can be used by callers.
- Returns:
- Specifies whether the ApiKey can be used by callers.
-
setStageKeys
public void setStageKeys(Collection<StageKey> stageKeys)
Specifies whether the ApiKey can be used by callers.
- Parameters:
stageKeys
- Specifies whether the ApiKey can be used by callers.
-
withStageKeys
public CreateApiKeyRequest withStageKeys(StageKey... stageKeys)
Specifies whether the ApiKey can be used by callers.
NOTE: This method appends the values to the existing list (if any). Use
setStageKeys(java.util.Collection)
orwithStageKeys(java.util.Collection)
if you want to override the existing values.- Parameters:
stageKeys
- Specifies whether the ApiKey can be used by callers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withStageKeys
public CreateApiKeyRequest withStageKeys(Collection<StageKey> stageKeys)
Specifies whether the ApiKey can be used by callers.
- Parameters:
stageKeys
- Specifies whether the ApiKey can be used by callers.- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateApiKeyRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-