public class ListRetirableGrantsRequest extends AmazonWebServiceRequest implements java.io.Serializable
Returns a list of all grants for which the grant's
RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
Constructor and Description |
---|
ListRetirableGrantsRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getLimit()
When paginating results, specify the maximum number of items to return in
the response.
|
java.lang.String |
getMarker()
Use this parameter only when paginating results and only in a subsequent
request after you receive a response with truncated results.
|
java.lang.String |
getRetiringPrincipal()
The retiring principal for which to list grants.
|
int |
hashCode() |
void |
setLimit(java.lang.Integer limit)
When paginating results, specify the maximum number of items to return in
the response.
|
void |
setMarker(java.lang.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(java.lang.String retiringPrincipal)
The retiring principal for which to list grants.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ListRetirableGrantsRequest |
withLimit(java.lang.Integer limit)
When paginating results, specify the maximum number of items to return in
the response.
|
ListRetirableGrantsRequest |
withMarker(java.lang.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(java.lang.String retiringPrincipal)
The retiring principal for which to list grants.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.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(java.lang.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 ListRetirableGrantsRequest withLimit(java.lang.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 java.lang.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(java.lang.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 ListRetirableGrantsRequest withMarker(java.lang.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 java.lang.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.
Constraints:
Length: 1 - 256
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.
public void setRetiringPrincipal(java.lang.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.
Constraints:
Length: 1 - 256
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.
public ListRetirableGrantsRequest withRetiringPrincipal(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.