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 Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the contact being engaged.The secure content of the message that was sent to the contact.idempotencyToken
(String idempotencyToken) A token ensuring that the operation is called only once with the specified details.incidentId
(String incidentId) The ARN of the incident that the engagement is part of.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.publicContent
(String publicContent) The insecure content of the message that was sent to the contact.publicSubject
(String publicSubject) The insecure subject of the message that was sent to the contact.The user that started the engagement.The secure subject of the message that was sent to the contact.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.ssmcontacts.model.SsmContactsRequest.Builder
build
-
Method Details
-
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
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
The secure subject of the message that was sent to the contact. Use this field for engagements to
VOICE
orEMAIL
.- Parameters:
subject
- The secure subject of the message that was sent to the contact. Use this field for engagements toVOICE
orEMAIL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
content
The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE
orEMAIL
.- Parameters:
content
- The secure content of the message that was sent to the contact. Use this field for engagements toVOICE
orEMAIL
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toSMS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 toSMS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-