Class EngagementInvitationSummary
- java.lang.Object
-
- software.amazon.awssdk.services.partnercentralselling.model.EngagementInvitationSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EngagementInvitationSummary.Builder,EngagementInvitationSummary>
@Generated("software.amazon.awssdk:codegen") public final class EngagementInvitationSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EngagementInvitationSummary.Builder,EngagementInvitationSummary>
Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEngagementInvitationSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the Engagement Invitation.static EngagementInvitationSummary.Builderbuilder()Stringcatalog()Specifies the catalog in which the Engagement Invitation resides.StringengagementId()The identifier of the Engagement associated with this invitation.StringengagementTitle()Provides a short title or description of the Engagement Invitation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpirationDate()Indicates the date and time when the Engagement Invitation will expire.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()Represents the unique identifier of the Engagement Invitation.InstantinvitationDate()Indicates the date when the Engagement Invitation was sent to the partner.ParticipantTypeparticipantType()Identifies the role of the caller in the engagement invitation.StringparticipantTypeAsString()Identifies the role of the caller in the engagement invitation.EngagementInvitationPayloadTypepayloadType()Describes the type of payload associated with the Engagement Invitation, such asOpportunityorMarketplaceOffer.StringpayloadTypeAsString()Describes the type of payload associated with the Engagement Invitation, such asOpportunityorMarketplaceOffer.Receiverreceiver()Specifies the partner company or individual that received the Engagement Invitation.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsenderAwsAccountId()Specifies the AWS account ID of the sender who initiated the Engagement Invitation.StringsenderCompanyName()Indicates the name of the company or AWS division that sent the Engagement Invitation.static Class<? extends EngagementInvitationSummary.Builder>serializableBuilderClass()InvitationStatusstatus()Represents the current status of the Engagement Invitation, such asPending,Accepted, orRejected.StringstatusAsString()Represents the current status of the Engagement Invitation, such asPending,Accepted, orRejected.EngagementInvitationSummary.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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
- Returns:
- The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
-
catalog
public final String catalog()
Specifies the catalog in which the Engagement Invitation resides. This can be either the
AWSorSandboxcatalog, indicating whether the opportunity is live or being tested.- Returns:
- Specifies the catalog in which the Engagement Invitation resides. This can be either the
AWSorSandboxcatalog, indicating whether the opportunity is live or being tested.
-
engagementId
public final String engagementId()
The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
- Returns:
- The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.
-
engagementTitle
public final String engagementTitle()
Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
- Returns:
- Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
-
expirationDate
public final Instant expirationDate()
Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
- Returns:
- Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.
-
id
public final String id()
Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
- Returns:
- Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
-
invitationDate
public final Instant invitationDate()
Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
- Returns:
- Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
-
participantType
public final ParticipantType participantType()
Identifies the role of the caller in the engagement invitation.
If the service returns an enum value that is not available in the current SDK version,
participantTypewill returnParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromparticipantTypeAsString().- Returns:
- Identifies the role of the caller in the engagement invitation.
- See Also:
ParticipantType
-
participantTypeAsString
public final String participantTypeAsString()
Identifies the role of the caller in the engagement invitation.
If the service returns an enum value that is not available in the current SDK version,
participantTypewill returnParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromparticipantTypeAsString().- Returns:
- Identifies the role of the caller in the engagement invitation.
- See Also:
ParticipantType
-
payloadType
public final EngagementInvitationPayloadType payloadType()
Describes the type of payload associated with the Engagement Invitation, such as
OpportunityorMarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.If the service returns an enum value that is not available in the current SDK version,
payloadTypewill returnEngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompayloadTypeAsString().- Returns:
- Describes the type of payload associated with the Engagement Invitation, such as
OpportunityorMarketplaceOffer. This helps partners understand the nature of the engagement request from AWS. - See Also:
EngagementInvitationPayloadType
-
payloadTypeAsString
public final String payloadTypeAsString()
Describes the type of payload associated with the Engagement Invitation, such as
OpportunityorMarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.If the service returns an enum value that is not available in the current SDK version,
payloadTypewill returnEngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompayloadTypeAsString().- Returns:
- Describes the type of payload associated with the Engagement Invitation, such as
OpportunityorMarketplaceOffer. This helps partners understand the nature of the engagement request from AWS. - See Also:
EngagementInvitationPayloadType
-
receiver
public final Receiver receiver()
Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
- Returns:
- Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
-
senderAwsAccountId
public final String senderAwsAccountId()
Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
- Returns:
- Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
-
senderCompanyName
public final String senderCompanyName()
Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
- Returns:
- Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
-
status
public final InvitationStatus status()
Represents the current status of the Engagement Invitation, such as
Pending,Accepted, orRejected. The status helps track the progress and response to the invitation.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:
- Represents the current status of the Engagement Invitation, such as
Pending,Accepted, orRejected. The status helps track the progress and response to the invitation. - See Also:
InvitationStatus
-
statusAsString
public final String statusAsString()
Represents the current status of the Engagement Invitation, such as
Pending,Accepted, orRejected. The status helps track the progress and response to the invitation.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:
- Represents the current status of the Engagement Invitation, such as
Pending,Accepted, orRejected. The status helps track the progress and response to the invitation. - See Also:
InvitationStatus
-
toBuilder
public EngagementInvitationSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EngagementInvitationSummary.Builder,EngagementInvitationSummary>
-
builder
public static EngagementInvitationSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends EngagementInvitationSummary.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
-
-