Interface StartEngagementRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartEngagementRequest.Builder,StartEngagementRequest>, SdkBuilder<StartEngagementRequest.Builder,StartEngagementRequest>, SdkPojo, SdkRequest.Builder, SsmContactsRequest.Builder
Enclosing class:
StartEngagementRequest
public static interface StartEngagementRequest.Builder extends SsmContactsRequest.Builder, SdkPojo, CopyableBuilder<StartEngagementRequest.Builder,StartEngagementRequest>

  • Method Details

    • contactId

      StartEngagementRequest.Builder contactId(String contactId)

      The Amazon Resource Name (ARN) of the contact being engaged.

      Parameters:
      contactId - The Amazon Resource Name (ARN) of the contact being engaged.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sender

      StartEngagementRequest.Builder sender(String sender)

      The user that started the engagement.

      Parameters:
      sender - The user that started the engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subject

      StartEngagementRequest.Builder subject(String subject)

      The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

      Parameters:
      subject - The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • content

      StartEngagementRequest.Builder content(String content)

      The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

      Parameters:
      content - The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicSubject

      StartEngagementRequest.Builder publicSubject(String publicSubject)

      The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

      Parameters:
      publicSubject - The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicContent

      StartEngagementRequest.Builder publicContent(String publicContent)

      The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

      Parameters:
      publicContent - The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incidentId

      StartEngagementRequest.Builder incidentId(String incidentId)

      The ARN of the incident that the engagement is part of.

      Parameters:
      incidentId - The ARN of the incident that the engagement is part of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idempotencyToken

      StartEngagementRequest.Builder idempotencyToken(String idempotencyToken)

      A token ensuring that the operation is called only once with the specified details.

      Parameters:
      idempotencyToken - A token ensuring that the operation is called only once with the specified details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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