Package software.amazon.awssdk.services.ssmcontacts.model

Class CreateContactChannelRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContactChannelRequest.Builder,CreateContactChannelRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateContactChannelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateContactChannelRequest.Builder	builder()
String	contactId()	The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
Boolean	deferActivation()	If you want to activate the channel at a later time, you can choose to defer activation.
ContactChannelAddress	deliveryAddress()	The details that Incident Manager uses when trying to engage the contact channel.
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	name()	The name of the contact channel.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContactChannelRequest.Builder>	serializableBuilderClass()
CreateContactChannelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelType	type()	Incident Manager supports three types of contact channels:
String	typeAsString()	Incident Manager supports three types of contact channels:

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 you are adding the contact channel to.

Returns:

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

name

public final String name()

The name of the contact channel.

Returns:

The name of the contact channel.

type

public final ChannelType type()

Incident Manager supports three types of contact channels:

• SMS

• VOICE

• EMAIL

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Incident Manager supports three types of contact channels:

• SMS

• VOICE

• EMAIL

See Also:

ChannelType

typeAsString

public final String typeAsString()

Incident Manager supports three types of contact channels:

• SMS

• VOICE

• EMAIL

If the service returns an enum value that is not available in the current SDK version, type will return ChannelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Incident Manager supports three types of contact channels:

• SMS

• VOICE

• EMAIL

See Also:

ChannelType

deliveryAddress

public final ContactChannelAddress deliveryAddress()

The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

• SMS - '+' followed by the country code and phone number

• VOICE - '+' followed by the country code and phone number

• EMAIL - any standard email format

Returns:

The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

• SMS - '+' followed by the country code and phone number

• VOICE - '+' followed by the country code and phone number

• EMAIL - any standard email format

deferActivation

public final Boolean deferActivation()

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

Returns:

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

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 CreateContactChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContactChannelRequest.Builder,CreateContactChannelRequest>

Specified by:

toBuilder in class SsmContactsRequest

builder

public static CreateContactChannelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateContactChannelRequest.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