CreateApiKeyRequest (AWS SDK for Java

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

Constructors
Constructor and Description
`CreateApiKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateApiKeyRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`CreateApiKeyRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateApiKeyRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getCustomerId()` An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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.
`Map<String,String>`	`getTags()` The key-value map of strings.
`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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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`	`setTags(Map<String,String> tags)` The key-value map of strings.
`void`	`setValue(String value)` Specifies a value of the API key.
`String`	`toString()` Returns a string representation of this object.
`CreateApiKeyRequest`	`withCustomerId(String customerId)` An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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`	`withTags(Map<String,String> tags)` The key-value map of strings.
`CreateApiKeyRequest`	`withValue(String value)` Specifies a value of the API key.

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. This parameter is deprecated and should not be used.
    
    Parameters:
    
    generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
  - getGenerateDistinctId
```
public Boolean getGenerateDistinctId()
```
    Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
    
    Returns:
    
    Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
  - withGenerateDistinctId
```
public CreateApiKeyRequest withGenerateDistinctId(Boolean generateDistinctId)
```
    Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
    
    Parameters:
    
    generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
    
    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. This parameter is deprecated and should not be used.
    
    Returns:
    
    Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
  - 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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    
    Parameters:
    
    customerId - An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
  - getCustomerId
```
public String getCustomerId()
```
    An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    
    Returns:
    
    An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
  - withCustomerId
```
public CreateApiKeyRequest withCustomerId(String customerId)
```
    An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    
    Parameters:
    
    customerId - An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Returns:
    
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
  - withTags
```
public CreateApiKeyRequest withTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateApiKeyRequest addTagsEntry(String key,
                                        String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateApiKeyRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. 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 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()

AWS SDK for Java 1.x API Reference - 1.12.779

Class CreateApiKeyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateApiKeyRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setEnabled

getEnabled

withEnabled

isEnabled

setGenerateDistinctId

getGenerateDistinctId

withGenerateDistinctId

isGenerateDistinctId

setValue

getValue

withValue

getStageKeys

setStageKeys

withStageKeys

withStageKeys

setCustomerId

getCustomerId

withCustomerId

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone