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

Interface CreateEngagementRequest.Builder

    • Method Detail

      • catalog

        CreateEngagementRequest.Builder catalog​(String catalog)

        The CreateEngagementRequest$Catalog parameter 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 - The CreateEngagementRequest$Catalog parameter 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

        CreateEngagementRequest.Builder clientToken​(String clientToken)

        The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

        Parameters:
        clientToken - The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contexts

        CreateEngagementRequest.Builder contexts​(Collection<EngagementContextDetails> contexts)

        The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem , and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

        Parameters:
        contexts - The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contexts

        CreateEngagementRequest.Builder contexts​(EngagementContextDetails... contexts)

        The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem , and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

        Parameters:
        contexts - The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • contexts

        CreateEngagementRequest.Builder contexts​(Consumer<EngagementContextDetails.Builder>... contexts)

        The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem , and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

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

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

        Parameters:
        contexts - a consumer that will call methods on EngagementContextDetails.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #contexts(java.util.Collection)

      • description

        CreateEngagementRequest.Builder description​(String description)

        Provides a description of the Engagement.

        Parameters:
        description - Provides a description of the Engagement.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • title

        CreateEngagementRequest.Builder title​(String title)

        Specifies the title of the Engagement.

        Parameters:
        title - Specifies the title of the Engagement.
        Returns:
        Returns a reference to this object so that method calls can be chained together.