Interface CreateEngagementContextRequest.Builder

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

  • Method Details

    • catalog

      CreateEngagementContextRequest.Builder catalog(String catalog)

      Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.

      Parameters:
      catalog - Specifies the catalog associated with the engagement context request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is created in. Use AWS to create contexts in the production environment, and Sandbox for testing in secure, isolated environments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      CreateEngagementContextRequest.Builder engagementIdentifier(String engagementIdentifier)

      The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.

      Parameters:
      engagementIdentifier - The unique identifier of the Engagement for which the context is being created. This parameter ensures the context is associated with the correct engagement and provides the necessary linkage between the engagement and its contextual information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateEngagementContextRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.

      Parameters:
      clientToken - A unique, case-sensitive identifier provided by the client to ensure that the request is handled exactly once. This token helps prevent duplicate context creations and must not exceed sixty-four alphanumeric characters. Use a UUID or other unique string to ensure idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateEngagementContextRequest.Builder type(String type)

      Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.

      Parameters:
      type - Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateEngagementContextRequest.Builder type(EngagementContextType type)

      Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.

      Parameters:
      type - Specifies the type of context being created for the engagement. This field determines the structure and content of the context payload. Valid values include CustomerProject for customer project-related contexts. The type field ensures that the context is properly categorized and processed according to its intended purpose.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payload

      CreateEngagementContextRequest.Builder payload(EngagementContextPayload payload)
      Sets the value of the Payload property for this object.
      Parameters:
      payload - The new value for the Payload property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      default CreateEngagementContextRequest.Builder payload(Consumer<EngagementContextPayload.Builder> payload)
      Sets the value of the Payload property for this object. This is a convenience method that creates an instance of the EngagementContextPayload.Builder avoiding the need to create one manually via EngagementContextPayload.builder().

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

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

    • overrideConfiguration

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

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