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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GrantListEntry.Builder,GrantListEntry>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.