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

Class ContactChannel

java.lang.Object

software.amazon.awssdk.services.ssmcontacts.model.ContactChannel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContactChannel.Builder,ContactChannel>

@Generated("software.amazon.awssdk:codegen")
public final class ContactChannel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContactChannel.Builder,ContactChannel>

The method that Incident Manager uses to engage a contact.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContactChannel.Builder

Method Summary

Modifier and Type	Method	Description
ActivationStatus	activationStatus()	A Boolean value describing if the contact channel has been activated or not.
String	activationStatusAsString()	A Boolean value describing if the contact channel has been activated or not.
static ContactChannel.Builder	builder()
String	contactArn()	The ARN of the contact that contains the contact channel.
String	contactChannelArn()	The Amazon Resource Name (ARN) of the contact channel.
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	name()	The name of the contact channel.
List<SdkField<?>>	sdkFields()
static Class<? extends ContactChannel.Builder>	serializableBuilderClass()
ContactChannel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelType	type()	The type of the contact channel.
String	typeAsString()	The type of the contact channel.

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

contactChannelArn

public final String contactChannelArn()

The Amazon Resource Name (ARN) of the contact channel.

Returns:

The Amazon Resource Name (ARN) of the contact channel.

contactArn

public final String contactArn()

The ARN of the contact that contains the contact channel.

Returns:

The ARN of the contact that contains the contact channel.

name

public final String name()

The name of the contact channel.

Returns:

The name of the contact channel.

type

public final ChannelType type()

The type of the contact channel. Incident Manager supports three contact methods:

• 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:

The type of the contact channel. Incident Manager supports three contact methods:

• SMS

• VOICE

• EMAIL

See Also:

ChannelType

typeAsString

public final String typeAsString()

The type of the contact channel. Incident Manager supports three contact methods:

• 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:

The type of the contact channel. Incident Manager supports three contact methods:

• SMS

• VOICE

• EMAIL

See Also:

ChannelType

deliveryAddress

public final ContactChannelAddress deliveryAddress()

The details that Incident Manager uses when trying to engage the contact channel.

Returns:

The details that Incident Manager uses when trying to engage the contact channel.

activationStatus

public final ActivationStatus activationStatus()

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

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

Returns:

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

See Also:

ActivationStatus

activationStatusAsString

public final String activationStatusAsString()

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

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

Returns:

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

See Also:

ActivationStatus

toBuilder

public ContactChannel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContactChannel.Builder,ContactChannel>

builder

public static ContactChannel.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo