Class ListRetirableGrantsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.kms.model.ListRetirableGrantsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ListRetirableGrantsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ListRetirableGrantsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListRetirableGrantsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
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.String
getRetiringPrincipal()
The retiring principal for which to list grants.int
hashCode()
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.void
setRetiringPrincipal(String retiringPrincipal)
The retiring principal for which to list grants.String
toString()
Returns a string representation of this object; useful for testing and debugging.ListRetirableGrantsRequest
withLimit(Integer limit)
When paginating results, specify the maximum number of items to return in the response.ListRetirableGrantsRequest
withMarker(String marker)
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.ListRetirableGrantsRequest
withRetiringPrincipal(String retiringPrincipal)
The retiring principal for which to list grants.-
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 ListRetirableGrantsRequest 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 ListRetirableGrantsRequest 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.
-
setRetiringPrincipal
public void setRetiringPrincipal(String retiringPrincipal)
The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
- Parameters:
retiringPrincipal
- The retiring principal for which to list grants.To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
-
getRetiringPrincipal
public String getRetiringPrincipal()
The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
- Returns:
- The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
-
withRetiringPrincipal
public ListRetirableGrantsRequest withRetiringPrincipal(String retiringPrincipal)
The retiring principal for which to list grants.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
- Parameters:
retiringPrincipal
- The retiring principal for which to list grants.To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
- 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 ListRetirableGrantsRequest 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()
-
-