Class GetEngagementInvitationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
software.amazon.awssdk.services.partnercentralselling.model.GetEngagementInvitationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEngagementInvitationResponse extends PartnerCentralSellingResponse implements ToCopyableBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that identifies the engagement invitation.

      Returns:
      The Amazon Resource Name (ARN) that identifies the engagement invitation.

    • catalog

      public final String catalog()

      Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

      Returns:
      Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

    • engagementDescription

      public final String engagementDescription()

      The description of the engagement associated with this invitation.

      Returns:
      The description of the engagement associated with this invitation.

    • engagementId

      public final String engagementId()

      The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

      Returns:
      The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

    • engagementTitle

      public final String engagementTitle()

      The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

      Returns:
      The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

    • hasExistingMembers

      public final boolean hasExistingMembers()
      For responses, this returns true if the service returned a value for the ExistingMembers 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.

    • existingMembers

      public final List<EngagementMemberSummary> existingMembers()

      A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.

      • CompanyName: The name of the member's company.

      • WebsiteUrl: The website URL of the member's company.

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

      Returns:
      A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.

      • CompanyName: The name of the member's company.

      • WebsiteUrl: The website URL of the member's company.

    • expirationDate

      public final Instant expirationDate()

      Indicates the date on which the engagement invitation will expire if not accepted by the partner.

      Returns:
      Indicates the date on which the engagement invitation will expire if not accepted by the partner.

    • id

      public final String id()

      Unique identifier assigned to the engagement invitation being retrieved.

      Returns:
      Unique identifier assigned to the engagement invitation being retrieved.

    • invitationDate

      public final Instant invitationDate()

      The date when the engagement invitation was sent to the partner.

      Returns:
      The date when the engagement invitation was sent to the partner.

    • invitationMessage

      public final String invitationMessage()

      The message sent to the invited partner when the invitation was created.

      Returns:
      The message sent to the invited partner when the invitation was created.

    • payload

      public final Payload payload()

      Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

      Returns:
      Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

    • payloadType

      public final EngagementInvitationPayloadType payloadType()

      The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

      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:
      The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
      See Also:

    • payloadTypeAsString

      public final String payloadTypeAsString()

      The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

      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:
      The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
      See Also:

    • receiver

      public final Receiver receiver()

      Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

      Returns:
      Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

    • rejectionReason

      public final String rejectionReason()

      If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

      Returns:
      If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

    • senderAwsAccountId

      public final String senderAwsAccountId()

      Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

      Returns:
      Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

    • senderCompanyName

      public final String senderCompanyName()

      The name of the AWS organization or team that sent the engagement invitation.

      Returns:
      The name of the AWS organization or team that sent the engagement invitation.

    • status

      public final InvitationStatus status()

      The current status of the engagement 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:
      The current status of the engagement invitation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the engagement 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:
      The current status of the engagement invitation.
      See Also:

    • toBuilder

      public GetEngagementInvitationResponse.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<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEngagementInvitationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEngagementInvitationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.