Package software.amazon.awssdk.services.partnercentralselling.model

Interface GetEngagementInvitationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>, PartnerCentralSellingResponse.Builder, SdkBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetEngagementInvitationResponse

public static interface GetEngagementInvitationResponse.Builder
extends PartnerCentralSellingResponse.Builder, SdkPojo, CopyableBuilder<GetEngagementInvitationResponse.Builder,GetEngagementInvitationResponse>

Method Summary

Modifier and Type	Method	Description
GetEngagementInvitationResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) that identifies the engagement invitation.
GetEngagementInvitationResponse.Builder	catalog(String catalog)	Indicates the catalog from which the engagement invitation details are retrieved.
GetEngagementInvitationResponse.Builder	engagementDescription(String engagementDescription)	The description of the engagement associated with this invitation.
GetEngagementInvitationResponse.Builder	engagementId(String engagementId)	The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.
GetEngagementInvitationResponse.Builder	engagementTitle(String engagementTitle)	The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.
GetEngagementInvitationResponse.Builder	existingMembers(Collection<EngagementMemberSummary> existingMembers)	A list of active members currently part of the Engagement.
GetEngagementInvitationResponse.Builder	existingMembers(Consumer<EngagementMemberSummary.Builder>... existingMembers)	A list of active members currently part of the Engagement.
GetEngagementInvitationResponse.Builder	existingMembers(EngagementMemberSummary... existingMembers)	A list of active members currently part of the Engagement.
GetEngagementInvitationResponse.Builder	expirationDate(Instant expirationDate)	Indicates the date on which the engagement invitation will expire if not accepted by the partner.
GetEngagementInvitationResponse.Builder	id(String id)	Unique identifier assigned to the engagement invitation being retrieved.
GetEngagementInvitationResponse.Builder	invitationDate(Instant invitationDate)	The date when the engagement invitation was sent to the partner.
GetEngagementInvitationResponse.Builder	invitationMessage(String invitationMessage)	The message sent to the invited partner when the invitation was created.
default GetEngagementInvitationResponse.Builder	payload(Consumer<Payload.Builder> payload)	Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
GetEngagementInvitationResponse.Builder	payload(Payload payload)	Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.
GetEngagementInvitationResponse.Builder	payloadType(String payloadType)	The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
GetEngagementInvitationResponse.Builder	payloadType(EngagementInvitationPayloadType payloadType)	The type of payload contained in the engagement invitation, indicating what data or context the payload covers.
default GetEngagementInvitationResponse.Builder	receiver(Consumer<Receiver.Builder> receiver)	Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
GetEngagementInvitationResponse.Builder	receiver(Receiver receiver)	Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.
GetEngagementInvitationResponse.Builder	rejectionReason(String rejectionReason)	If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.
GetEngagementInvitationResponse.Builder	senderAwsAccountId(String senderAwsAccountId)	Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.
GetEngagementInvitationResponse.Builder	senderCompanyName(String senderCompanyName)	The name of the AWS organization or team that sent the engagement invitation.
GetEngagementInvitationResponse.Builder	status(String status)	The current status of the engagement invitation.
GetEngagementInvitationResponse.Builder	status(InvitationStatus status)	The current status of the engagement invitation.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

arn

GetEngagementInvitationResponse.Builder arn(String arn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

catalog

GetEngagementInvitationResponse.Builder catalog(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engagementDescription

GetEngagementInvitationResponse.Builder engagementDescription(String engagementDescription)

The description of the engagement associated with this invitation.

Parameters:

engagementDescription - The description of the engagement associated with this invitation.

Returns:

Returns a reference to this object so that method calls can be chained together.

engagementId

GetEngagementInvitationResponse.Builder engagementId(String engagementId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

engagementTitle

GetEngagementInvitationResponse.Builder engagementTitle(String engagementTitle)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

existingMembers

GetEngagementInvitationResponse.Builder existingMembers(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

existingMembers

GetEngagementInvitationResponse.Builder existingMembers(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

existingMembers

GetEngagementInvitationResponse.Builder existingMembers(Consumer<EngagementMemberSummary.Builder>... 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.

This is a convenience method that creates an instance of the EngagementMemberSummary.Builder avoiding the need to create one manually via EngagementMemberSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #existingMembers(List).

Parameters:

existingMembers - a consumer that will call methods on EngagementMemberSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#existingMembers(java.util.Collection)

expirationDate

GetEngagementInvitationResponse.Builder expirationDate(Instant expirationDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

id

GetEngagementInvitationResponse.Builder id(String id)

Unique identifier assigned to the engagement invitation being retrieved.

Parameters:

id - Unique identifier assigned to the engagement invitation being retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

invitationDate

GetEngagementInvitationResponse.Builder invitationDate(Instant invitationDate)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

invitationMessage

GetEngagementInvitationResponse.Builder invitationMessage(String invitationMessage)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

payload

GetEngagementInvitationResponse.Builder payload(Payload payload)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

payload

default GetEngagementInvitationResponse.Builder payload(Consumer<Payload.Builder> payload)

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

This is a convenience method that creates an instance of the Payload.Builder avoiding the need to create one manually via Payload.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(Payload).

Parameters:

payload - a consumer that will call methods on Payload.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

payload(Payload)

payloadType

GetEngagementInvitationResponse.Builder payloadType(String payloadType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EngagementInvitationPayloadType, EngagementInvitationPayloadType

payloadType

GetEngagementInvitationResponse.Builder payloadType(EngagementInvitationPayloadType payloadType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EngagementInvitationPayloadType, EngagementInvitationPayloadType

receiver

GetEngagementInvitationResponse.Builder receiver(Receiver receiver)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

receiver

default GetEngagementInvitationResponse.Builder receiver(Consumer<Receiver.Builder> receiver)

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

This is a convenience method that creates an instance of the Receiver.Builder avoiding the need to create one manually via Receiver.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to receiver(Receiver).

Parameters:

receiver - a consumer that will call methods on Receiver.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

receiver(Receiver)

rejectionReason

GetEngagementInvitationResponse.Builder rejectionReason(String rejectionReason)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

senderAwsAccountId

GetEngagementInvitationResponse.Builder senderAwsAccountId(String senderAwsAccountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

senderCompanyName

GetEngagementInvitationResponse.Builder senderCompanyName(String senderCompanyName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetEngagementInvitationResponse.Builder status(String status)

The current status of the engagement invitation.

Parameters:

status - The current status of the engagement invitation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InvitationStatus, InvitationStatus

status

GetEngagementInvitationResponse.Builder status(InvitationStatus status)

The current status of the engagement invitation.

Parameters:

status - The current status of the engagement invitation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InvitationStatus, InvitationStatus