Class ResourceShareInvitation

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

Describes an invitation for an Amazon Web Services account to join a resource share.

See Also:

  • Method Details

    • resourceShareInvitationArn

      public final String resourceShareInvitationArn()

      The Amazon Resource Name (ARN) of the invitation.

      Returns:
      The Amazon Resource Name (ARN) of the invitation.

    • resourceShareName

      public final String resourceShareName()

      The name of the resource share.

      Returns:
      The name of the resource share.

    • resourceShareArn

      public final String resourceShareArn()

      The Amazon Resource Name (ARN) of the resource share

      Returns:
      The Amazon Resource Name (ARN) of the resource share

    • senderAccountId

      public final String senderAccountId()

      The ID of the Amazon Web Services account that sent the invitation.

      Returns:
      The ID of the Amazon Web Services account that sent the invitation.

    • receiverAccountId

      public final String receiverAccountId()

      The ID of the Amazon Web Services account that received the invitation.

      Returns:
      The ID of the Amazon Web Services account that received the invitation.

    • invitationTimestamp

      public final Instant invitationTimestamp()

      The date and time when the invitation was sent.

      Returns:
      The date and time when the invitation was sent.

    • status

      public final ResourceShareInvitationStatus status()

      The current status of the invitation.

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

      Returns:
      The current status of the invitation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the invitation.

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

      Returns:
      The current status of the invitation.
      See Also:

    • hasResourceShareAssociations

      @Deprecated public final boolean hasResourceShareAssociations()
      Deprecated.
      This member has been deprecated. Use ListPendingInvitationResources.
      For responses, this returns true if the service returned a value for the ResourceShareAssociations 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.

    • resourceShareAssociations

      @Deprecated public final List<ResourceShareAssociation> resourceShareAssociations()
      Deprecated.
      This member has been deprecated. Use ListPendingInvitationResources.

      To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

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

      Returns:
      To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

    • receiverArn

      public final String receiverArn()

      The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.

      Returns:
      The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.

    • toBuilder

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

    • builder

      public static ResourceShareInvitation.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.