com.amazonaws.services.apigateway.model

Class GetApiKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.GetApiKeysRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

A request to get information about the current ApiKeys resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetApiKeysRequest()

Method Summary

Modifier and Type	Method and Description
GetApiKeysRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCustomerId() The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
Boolean	getIncludeValues() A boolean flag to specify whether (true) or not (false) the result contains key values.
Integer	getLimit() The maximum number of returned results per page.
String	getNameQuery() The name of queried API keys.
String	getPosition() The current pagination position in the paged result set.
int	hashCode()
Boolean	isIncludeValues() A boolean flag to specify whether (true) or not (false) the result contains key values.
void	setCustomerId(String customerId) The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
void	setIncludeValues(Boolean includeValues) A boolean flag to specify whether (true) or not (false) the result contains key values.
void	setLimit(Integer limit) The maximum number of returned results per page.
void	setNameQuery(String nameQuery) The name of queried API keys.
void	setPosition(String position) The current pagination position in the paged result set.
String	toString() Returns a string representation of this object.
GetApiKeysRequest	withCustomerId(String customerId) The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
GetApiKeysRequest	withIncludeValues(Boolean includeValues) A boolean flag to specify whether (true) or not (false) the result contains key values.
GetApiKeysRequest	withLimit(Integer limit) The maximum number of returned results per page.
GetApiKeysRequest	withNameQuery(String nameQuery) The name of queried API keys.
GetApiKeysRequest	withPosition(String position) The current pagination position in the paged result set.

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

GetApiKeysRequest

public GetApiKeysRequest()

Method Detail

setPosition

public void setPosition(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

getPosition

public String getPosition()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

withPosition

public GetApiKeysRequest withPosition(String position)

The current pagination position in the paged result set.

Parameters:

position - The current pagination position in the paged result set.

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getLimit

public Integer getLimit()

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

withLimit

public GetApiKeysRequest withLimit(Integer limit)

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Parameters:

limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

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

setNameQuery

public void setNameQuery(String nameQuery)

The name of queried API keys.

Parameters:

nameQuery - The name of queried API keys.

getNameQuery

public String getNameQuery()

The name of queried API keys.

Returns:

The name of queried API keys.

withNameQuery

public GetApiKeysRequest withNameQuery(String nameQuery)

The name of queried API keys.

Parameters:

nameQuery - The name of queried API keys.

Returns:

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

setCustomerId

public void setCustomerId(String customerId)

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

Parameters:

customerId - The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

getCustomerId

public String getCustomerId()

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

Returns:

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

withCustomerId

public GetApiKeysRequest withCustomerId(String customerId)

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

Parameters:

customerId - The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

Returns:

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

setIncludeValues

public void setIncludeValues(Boolean includeValues)

A boolean flag to specify whether (true) or not (false) the result contains key values.

Parameters:

includeValues - A boolean flag to specify whether (true) or not (false) the result contains key values.

getIncludeValues

public Boolean getIncludeValues()

A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:

A boolean flag to specify whether (true) or not (false) the result contains key values.

withIncludeValues

public GetApiKeysRequest withIncludeValues(Boolean includeValues)

A boolean flag to specify whether (true) or not (false) the result contains key values.

Parameters:

includeValues - A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:

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

isIncludeValues

public Boolean isIncludeValues()

A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:

A boolean flag to specify whether (true) or not (false) the result contains key values.

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