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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetEngagementInvitationResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) that identifies the engagement invitation.static GetEngagementInvitationResponse.Builderbuilder()Stringcatalog()Indicates the catalog from which the engagement invitation details are retrieved.StringengagementDescription()The description of the engagement associated with this invitation.StringengagementId()The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.StringengagementTitle()The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<EngagementMemberSummary>existingMembers()A list of active members currently part of the Engagement.InstantexpirationDate()Indicates the date on which the engagement invitation will expire if not accepted by the partner.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExistingMembers()For responses, this returns true if the service returned a value for the ExistingMembers property.inthashCode()Stringid()Unique identifier assigned to the engagement invitation being retrieved.InstantinvitationDate()The date when the engagement invitation was sent to the partner.StringinvitationMessage()The message sent to the invited partner when the invitation was created.Payloadpayload()Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.EngagementInvitationPayloadTypepayloadType()The type of payload contained in the engagement invitation, indicating what data or context the payload covers.StringpayloadTypeAsString()The type of payload contained in the engagement invitation, indicating what data or context the payload covers.Receiverreceiver()Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.StringrejectionReason()If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsenderAwsAccountId()Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.StringsenderCompanyName()The name of the AWS organization or team that sent the engagement invitation.static Class<? extends GetEngagementInvitationResponse.Builder>serializableBuilderClass()InvitationStatusstatus()The current status of the engagement invitation.StringstatusAsString()The current status of the engagement invitation.GetEngagementInvitationResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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) 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.,
AWSorSandbox) 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.,
AWSorSandbox) 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 theisEmpty()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,
payloadTypewill returnEngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompayloadTypeAsString().- Returns:
- The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
- See Also:
EngagementInvitationPayloadType
-
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,
payloadTypewill returnEngagementInvitationPayloadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompayloadTypeAsString().- Returns:
- The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
- See Also:
EngagementInvitationPayloadType
-
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,
statuswill returnInvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the engagement invitation.
- See Also:
InvitationStatus
-
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,
statuswill returnInvitationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the engagement invitation.
- See Also:
InvitationStatus
-
toBuilder
public GetEngagementInvitationResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetEngagementInvitationResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetEngagementInvitationResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-