@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListGrantsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListGrantsRequest() |
Modifier and Type | Method and Description |
---|---|
ListGrantsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getGranteePrincipal()
Returns only grants where the specified principal is the grantee principal for the grant.
|
String |
getGrantId()
Returns only the grant with the specified grant ID.
|
String |
getKeyId()
Returns only grants for the specified KMS key.
|
Integer |
getLimit()
Use this parameter to specify the maximum number of items to return.
|
String |
getMarker()
Use this parameter in a subsequent request after you receive a response with truncated results.
|
int |
hashCode() |
void |
setGranteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
|
void |
setGrantId(String grantId)
Returns only the grant with the specified grant ID.
|
void |
setKeyId(String keyId)
Returns only grants for the specified KMS key.
|
void |
setLimit(Integer limit)
Use this parameter to specify the maximum number of items to return.
|
void |
setMarker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results.
|
String |
toString()
Returns a string representation of this object.
|
ListGrantsRequest |
withGranteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
|
ListGrantsRequest |
withGrantId(String grantId)
Returns only the grant with the specified grant ID.
|
ListGrantsRequest |
withKeyId(String keyId)
Returns only grants for the specified KMS key.
|
ListGrantsRequest |
withLimit(Integer limit)
Use this parameter to specify the maximum number of items to return.
|
ListGrantsRequest |
withMarker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results.
|
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
public void setLimit(Integer limit)
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
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.
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, KMS does
not return more than the specified number of items, but it might return fewer.
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 Integer getLimit()
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
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.
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)
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
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.
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, KMS does
not return more than the specified number of items, but it might return fewer.
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 setMarker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker
from the truncated response you just received.
marker
- Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
the value of NextMarker
from the truncated response you just received.public String getMarker()
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker
from the truncated response you just received.
NextMarker
from the truncated response you just received.public ListGrantsRequest withMarker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker
from the truncated response you just received.
marker
- Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
the value of NextMarker
from the truncated response you just received.public void setKeyId(String keyId)
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
keyId
- Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
public String getKeyId()
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
public ListGrantsRequest withKeyId(String keyId)
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
keyId
- Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
public void setGrantId(String grantId)
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
grantId
- Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.public String getGrantId()
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
public ListGrantsRequest withGrantId(String grantId)
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
grantId
- Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.public void setGranteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
granteePrincipal
- Returns only grants where the specified principal is the grantee principal for the grant.public String getGranteePrincipal()
Returns only grants where the specified principal is the grantee principal for the grant.
public ListGrantsRequest withGranteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
granteePrincipal
- Returns only grants where the specified principal is the grantee principal for the grant.public String toString()
toString
in class Object
Object.toString()
public ListGrantsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()