Class ListRetirableGrantsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.kms.model.KmsRequest
-
- software.amazon.awssdk.services.kms.model.ListRetirableGrantsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListRetirableGrantsRequest extends KmsRequest implements ToCopyableBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListRetirableGrantsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListRetirableGrantsRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Integer
limit()
Use this parameter to specify the maximum number of items to return.String
marker()
Use this parameter in a subsequent request after you receive a response with truncated results.String
retiringPrincipal()
The retiring principal for which to list grants.List<SdkField<?>>
sdkFields()
static Class<? extends ListRetirableGrantsRequest.Builder>
serializableBuilderClass()
ListRetirableGrantsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
limit
public final 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.
- Returns:
- 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.
-
marker
public final 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.- Returns:
- 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.
-
retiringPrincipal
public final String retiringPrincipal()
The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
- Returns:
- The retiring principal for which to list grants. Enter a principal in your Amazon Web Services
account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .
-
toBuilder
public ListRetirableGrantsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListRetirableGrantsRequest.Builder,ListRetirableGrantsRequest>
- Specified by:
toBuilder
in classKmsRequest
-
builder
public static ListRetirableGrantsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListRetirableGrantsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-