Interface CreateEngagementInvitationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEngagementInvitationRequest.Builder,CreateEngagementInvitationRequest>, PartnerCentralSellingRequest.Builder, SdkBuilder<CreateEngagementInvitationRequest.Builder,CreateEngagementInvitationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEngagementInvitationRequest
@Mutable @NotThreadSafe public static interface CreateEngagementInvitationRequest.Builder extends PartnerCentralSellingRequest.Builder, SdkPojo, CopyableBuilder<CreateEngagementInvitationRequest.Builder,CreateEngagementInvitationRequest>

  • Method Details

    • catalog

      CreateEngagementInvitationRequest.Builder catalog(String catalog)

      Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

      Parameters:
      catalog - Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateEngagementInvitationRequest.Builder clientToken(String clientToken)

      Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

      Parameters:
      clientToken - Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      CreateEngagementInvitationRequest.Builder engagementIdentifier(String engagementIdentifier)

      The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

      Parameters:
      engagementIdentifier - The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invitation

      CreateEngagementInvitationRequest.Builder invitation(Invitation invitation)

      The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

      Parameters:
      invitation - The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • invitation

      default CreateEngagementInvitationRequest.Builder invitation(Consumer<Invitation.Builder> invitation)

      The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

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

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

      Parameters:
      invitation - a consumer that will call methods on Invitation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateEngagementInvitationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEngagementInvitationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.