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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceInvitation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the invitation.static Invitation.Builderbuilder()InstantcreationDate()The date and time that the invitation was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpirationDate()The date and time that the invitation expires.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringinvitationId()The unique identifier for the invitation.NetworkSummarynetworkSummary()Returns the value of the NetworkSummary property for this object.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Invitation.Builder>serializableBuilderClass()InvitationStatusstatus()The status of the invitation:StringstatusAsString()The status of the invitation:Invitation.BuildertoBuilder()StringtoString()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
-
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
CreationDateplus theProposalDurationInHoursthat is specified in theProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using thisInvitationId.- Returns:
- The date and time that the invitation expires. This is the
CreationDateplus theProposalDurationInHoursthat is specified in theProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using thisInvitationId.
-
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 theInvitationID. -
REJECTED- The invitee rejected the invitation. -
EXPIRED- The invitee neither created a member nor rejected the invitation before theExpirationDate.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnInvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 theInvitationID. -
REJECTED- The invitee rejected the invitation. -
EXPIRED- The invitee neither created a member nor rejected the invitation before theExpirationDate.
-
- See Also:
InvitationStatus
-
-
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 theInvitationID. -
REJECTED- The invitee rejected the invitation. -
EXPIRED- The invitee neither created a member nor rejected the invitation before theExpirationDate.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnInvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 theInvitationID. -
REJECTED- The invitee rejected the invitation. -
EXPIRED- The invitee neither created a member nor rejected the invitation before theExpirationDate.
-
- See Also:
InvitationStatus
-
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Invitation.Builder,Invitation>
-
builder
public static Invitation.Builder builder()
-
serializableBuilderClass
public static Class<? extends Invitation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-