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:

  • Method Details

    • 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 AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.

      Returns:
      Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, 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, participantType will return ParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantTypeAsString().

      Returns:
      Identifies the role of the caller in the engagement invitation.
      See Also:

    • 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, participantType will return ParticipantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from participantTypeAsString().

      Returns:
      Identifies the role of the caller in the engagement invitation.
      See Also:

    • payloadType

      public final EngagementInvitationPayloadType payloadType()

      Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. 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, payloadType will return EngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadTypeAsString().

      Returns:
      Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.
      See Also:

    • payloadTypeAsString

      public final String payloadTypeAsString()

      Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. 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, payloadType will return EngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from payloadTypeAsString().

      Returns:
      Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.
      See Also:

    • 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, or Rejected. 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, status will return InvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.
      See Also:

    • statusAsString

      public final String statusAsString()

      Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. 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, status will return InvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.
      See Also:

    • toBuilder

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

    • builder

      public static EngagementInvitationSummary.Builder builder()

    • serializableBuilderClass

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