Class ListGrantsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.kms.model.ListGrantsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListGrantsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListGrantsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListGrantsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getKeyId()
A unique identifier for the customer master key.Integer
getLimit()
When paginating results, specify the maximum number of items to return in the response.String
getMarker()
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.int
hashCode()
void
setKeyId(String keyId)
A unique identifier for the customer master key.void
setLimit(Integer limit)
When paginating results, specify the maximum number of items to return in the response.void
setMarker(String marker)
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.String
toString()
Returns a string representation of this object; useful for testing and debugging.ListGrantsRequest
withKeyId(String keyId)
A unique identifier for the customer master key.ListGrantsRequest
withLimit(Integer limit)
When paginating results, specify the maximum number of items to return in the response.ListGrantsRequest
withMarker(String marker)
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.-
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
-
setLimit
public void setLimit(Integer limit)
When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the
Truncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
- Parameters:
limit
- When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, theTruncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
-
getLimit
public Integer getLimit()
When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the
Truncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
- Returns:
- When paginating results, specify the maximum number of items to
return in the response. If additional items exist beyond the
number you specify, the
Truncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
-
withLimit
public ListGrantsRequest withLimit(Integer limit)
When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the
Truncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
- Parameters:
limit
- When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, theTruncated
element in the response is set to true.This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
public void setMarker(String marker)
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of
NextMarker
from the response you just received.- Parameters:
marker
- Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value ofNextMarker
from the response you just received.
-
getMarker
public String getMarker()
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of
NextMarker
from the response you just received.- Returns:
- Use this parameter only when paginating results and only in a
subsequent request after you receive a response with truncated
results. Set it to the value of
NextMarker
from the response you just received.
-
withMarker
public ListGrantsRequest withMarker(String marker)
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of
NextMarker
from the response you just received.- Parameters:
marker
- Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value ofNextMarker
from the response you just received.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeyId
public void setKeyId(String keyId)
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
- Parameters:
keyId
- A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
-
-
getKeyId
public String getKeyId()
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
- Returns:
- A unique identifier for the customer master key. This value can
be a globally unique identifier or the fully specified ARN to a
key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678- 1234-1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
-
-
withKeyId
public ListGrantsRequest withKeyId(String keyId)
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234 -1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
- Parameters:
keyId
- A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.-
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234 -1234-1234-123456789012
-
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
-
- 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 ListGrantsRequest 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()
-
-