Interface UpdateEngagementContextRequest.Builder

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

  • Method Details

    • catalog

      UpdateEngagementContextRequest.Builder catalog(String catalog)

      Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.

      Parameters:
      catalog - Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      UpdateEngagementContextRequest.Builder engagementIdentifier(String engagementIdentifier)

      The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.

      Parameters:
      engagementIdentifier - The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contextIdentifier

      UpdateEngagementContextRequest.Builder contextIdentifier(String contextIdentifier)

      The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.

      Parameters:
      contextIdentifier - The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementLastModifiedAt

      UpdateEngagementContextRequest.Builder engagementLastModifiedAt(Instant engagementLastModifiedAt)

      The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.

      Parameters:
      engagementLastModifiedAt - The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      UpdateEngagementContextRequest.Builder type(String type)

      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.

      Parameters:
      type - Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      UpdateEngagementContextRequest.Builder type(EngagementContextType type)

      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.

      Parameters:
      type - Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payload

      UpdateEngagementContextRequest.Builder payload(UpdateEngagementContextPayload payload)

      Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.

      Parameters:
      payload - Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      default UpdateEngagementContextRequest.Builder payload(Consumer<UpdateEngagementContextPayload.Builder> payload)

      Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.

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

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

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

    • overrideConfiguration

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

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