Class Invitation

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

An invitation to an Amazon Web Services account to create a member and join the network.

Applies only to Hyperledger Fabric.

See Also:

  • Method Details

    • invitationId

      public final String invitationId()

      The unique identifier for the invitation.

      Returns:
      The unique identifier for the invitation.

    • creationDate

      public final Instant creationDate()

      The date and time that the invitation was created.

      Returns:
      The date and time that the invitation was created.

    • expirationDate

      public final Instant expirationDate()

      The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

      Returns:
      The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

    • status

      public final InvitationStatus status()

      The status of the invitation:

      • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.

      • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.

      • ACCEPTED - The invitee created a member and joined the network using the InvitationID.

      • REJECTED - The invitee rejected the invitation.

      • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

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

      Returns:
      The status of the invitation:

      • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.

      • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.

      • ACCEPTED - The invitee created a member and joined the network using the InvitationID.

      • REJECTED - The invitee rejected the invitation.

      • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the invitation:

      • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.

      • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.

      • ACCEPTED - The invitee created a member and joined the network using the InvitationID.

      • REJECTED - The invitee rejected the invitation.

      • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

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

      Returns:
      The status of the invitation:

      • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.

      • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.

      • ACCEPTED - The invitee created a member and joined the network using the InvitationID.

      • REJECTED - The invitee rejected the invitation.

      • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

      See Also:

    • networkSummary

      public final NetworkSummary networkSummary()
      Returns the value of the NetworkSummary property for this object.
      Returns:
      The value of the NetworkSummary property for this object.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Returns:
      The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • toBuilder

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

    • builder

      public static Invitation.Builder builder()

    • serializableBuilderClass

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