Class Grant

java.lang.Object
software.amazon.awssdk.services.licensemanager.model.Grant
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Grant.Builder,Grant>
@Generated("software.amazon.awssdk:codegen") public final class Grant extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Grant.Builder,Grant>

Describes a grant.

See Also:

  • Method Details

    • grantArn

      public final String grantArn()

      Amazon Resource Name (ARN) of the grant.

      Returns:
      Amazon Resource Name (ARN) of the grant.

    • grantName

      public final String grantName()

      Grant name.

      Returns:
      Grant name.

    • parentArn

      public final String parentArn()

      Parent ARN.

      Returns:
      Parent ARN.

    • licenseArn

      public final String licenseArn()

      License ARN.

      Returns:
      License ARN.

    • granteePrincipalArn

      public final String granteePrincipalArn()

      The grantee principal ARN.

      Returns:
      The grantee principal ARN.

    • homeRegion

      public final String homeRegion()

      Home Region of the grant.

      Returns:
      Home Region of the grant.

    • grantStatus

      public final GrantStatus grantStatus()

      Grant status.

      If the service returns an enum value that is not available in the current SDK version, grantStatus will return GrantStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from grantStatusAsString().

      Returns:
      Grant status.
      See Also:

    • grantStatusAsString

      public final String grantStatusAsString()

      Grant status.

      If the service returns an enum value that is not available in the current SDK version, grantStatus will return GrantStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from grantStatusAsString().

      Returns:
      Grant status.
      See Also:

    • statusReason

      public final String statusReason()

      Grant status reason.

      Returns:
      Grant status reason.

    • version

      public final String version()

      Grant version.

      Returns:
      Grant version.

    • grantedOperations

      public final List<AllowedOperation> grantedOperations()

      Granted operations.

      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 hasGrantedOperations() method.

      Returns:
      Granted operations.

    • hasGrantedOperations

      public final boolean hasGrantedOperations()
      For responses, this returns true if the service returned a value for the GrantedOperations 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.

    • grantedOperationsAsStrings

      public final List<String> grantedOperationsAsStrings()

      Granted operations.

      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 hasGrantedOperations() method.

      Returns:
      Granted operations.

    • options

      public final Options options()

      The options specified for the grant.

      Returns:
      The options specified for the grant.

    • toBuilder

      public Grant.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<Grant.Builder,Grant>
      Returns:
      a builder for type T

    • builder

      public static Grant.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Grant.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.