public class ListGrantsRequest extends AmazonWebServiceRequest implements Serializable
List the grants for a specified key.
| Constructor and Description |
|---|
ListGrantsRequest() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic 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.
Constraints:
Range: 1 - 1000
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.
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.
Constraints:
Range: 1 - 1000
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.
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000
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.
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.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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.
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.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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.
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 320
Pattern: [ -ÿ]*
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.
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
Constraints:
Length: 1 - 256
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
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
Constraints:
Length: 1 - 256
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
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
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
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
public String toString()
toString in class ObjectObject.toString()Copyright © 2017. All rights reserved.