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:

  • Method Details

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

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

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

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

    • toBuilder

      public ContactChannel.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ContactChannel.Builder,ContactChannel>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.