software.amazon.awssdk.services.ssmcontacts.model

Class StartEngagementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmcontacts.model.SsmContactsRequest

software.amazon.awssdk.services.ssmcontacts.model.StartEngagementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartEngagementRequest.Builder,StartEngagementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartEngagementRequest
extends SsmContactsRequest
implements ToCopyableBuilder<StartEngagementRequest.Builder,StartEngagementRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartEngagementRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartEngagementRequest.Builder	builder()
String	contactId() The Amazon Resource Name (ARN) of the contact being engaged.
String	content() The secure content of the message that was sent to the contact.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	idempotencyToken() A token ensuring that the operation is called only once with the specified details.
String	incidentId() The ARN of the incident that the engagement is part of.
String	publicContent() The insecure content of the message that was sent to the contact.
String	publicSubject() The insecure subject of the message that was sent to the contact.
List<SdkField<?>>	sdkFields()
String	sender() The user that started the engagement.
static Class<? extends StartEngagementRequest.Builder>	serializableBuilderClass()
String	subject() The secure subject of the message that was sent to the contact.
StartEngagementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

contactId

public final String contactId()

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

Returns:

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

sender

public final String sender()

The user that started the engagement.

Returns:

The user that started the engagement.

subject

public final String subject()

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

Returns:

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

content

public final String content()

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

Returns:

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

publicSubject

public final String publicSubject()

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

Returns:

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

publicContent

public final String publicContent()

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

Returns:

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

incidentId

public final String incidentId()

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

Returns:

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

idempotencyToken

public final String idempotencyToken()

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

Returns:

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

toBuilder

public StartEngagementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartEngagementRequest.Builder,StartEngagementRequest>

Specified by:

toBuilder in class SsmContactsRequest

builder

public static StartEngagementRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartEngagementRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo