Package software.amazon.awssdk.services.kms.model

Class GrantListEntry

java.lang.Object

software.amazon.awssdk.services.kms.model.GrantListEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GrantListEntry.Builder,GrantListEntry>

@Generated("software.amazon.awssdk:codegen")
public final class GrantListEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GrantListEntry.Builder,GrantListEntry>

Contains information about a grant.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GrantListEntry.Builder

Method Summary

Modifier and Type	Method	Description
static GrantListEntry.Builder	builder()
GrantConstraints	constraints()	A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
Instant	creationDate()	The date and time when the grant was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	granteePrincipal()	The identity that gets the permissions in the grant.
String	grantId()	The unique identifier for the grant.
int	hashCode()
boolean	hasOperations()	For responses, this returns true if the service returned a value for the Operations property.
String	issuingAccount()	The Amazon Web Services account under which the grant was issued.
String	keyId()	The unique identifier for the KMS key to which the grant applies.
String	name()	The friendly name that identifies the grant.
List<GrantOperation>	operations()	The list of operations permitted by the grant.
List<String>	operationsAsStrings()	The list of operations permitted by the grant.
String	retiringPrincipal()	The principal that can retire the grant.
List<SdkField<?>>	sdkFields()
static Class<? extends GrantListEntry.Builder>	serializableBuilderClass()
GrantListEntry.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

keyId

public final String keyId()

The unique identifier for the KMS key to which the grant applies.

Returns:

The unique identifier for the KMS key to which the grant applies.

grantId

public final String grantId()

The unique identifier for the grant.

Returns:

The unique identifier for the grant.

name

public final String name()

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Returns:

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

creationDate

public final Instant creationDate()

The date and time when the grant was created.

Returns:

The date and time when the grant was created.

granteePrincipal

public final String granteePrincipal()

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Returns:

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

retiringPrincipal

public final String retiringPrincipal()

The principal that can retire the grant.

Returns:

The principal that can retire the grant.

issuingAccount

public final String issuingAccount()

The Amazon Web Services account under which the grant was issued.

Returns:

The Amazon Web Services account under which the grant was issued.

operations

public final List<GrantOperation> operations()

The list of operations permitted by the grant.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperations() method.

Returns:

The list of operations permitted by the grant.

hasOperations

public final boolean hasOperations()

For responses, this returns true if the service returned a value for the Operations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

operationsAsStrings

public final List<String> operationsAsStrings()

The list of operations permitted by the grant.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperations() method.

Returns:

The list of operations permitted by the grant.

constraints

public final GrantConstraints constraints()

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Returns:

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

toBuilder

public GrantListEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GrantListEntry.Builder,GrantListEntry>

builder

public static GrantListEntry.Builder builder()

serializableBuilderClass

public static Class<? extends GrantListEntry.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo