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>

  • Method Details

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

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

    • 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()
      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<CreateContactChannelRequest.Builder,CreateContactChannelRequest>
      Specified by:
      toBuilder in class SsmContactsRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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