Class CreateNotifyConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
software.amazon.awssdk.services.pinpointsmsvoicev2.model.CreateNotifyConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateNotifyConfigurationRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>

  • Method Details

    • displayName

      public final String displayName()

      The display name to associate with the notify configuration.

      Returns:
      The display name to associate with the notify configuration.

    • useCase

      public final NotifyConfigurationUseCase useCase()

      The use case for the notify configuration.

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

      Returns:
      The use case for the notify configuration.
      See Also:

    • useCaseAsString

      public final String useCaseAsString()

      The use case for the notify configuration.

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

      Returns:
      The use case for the notify configuration.
      See Also:

    • defaultTemplateId

      public final String defaultTemplateId()

      The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

      Returns:
      The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

    • poolId

      public final String poolId()

      The identifier of the pool to associate with the notify configuration.

      Returns:
      The identifier of the pool to associate with the notify configuration.

    • hasEnabledCountries

      public final boolean hasEnabledCountries()
      For responses, this returns true if the service returned a value for the EnabledCountries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enabledCountries

      public final List<String> enabledCountries()

      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnabledCountries() method.

      Returns:
      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

    • enabledChannels

      public final List<NumberCapability> enabledChannels()

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnabledChannels() method.

      Returns:
      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

    • hasEnabledChannels

      public final boolean hasEnabledChannels()
      For responses, this returns true if the service returned a value for the EnabledChannels property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • enabledChannelsAsStrings

      public final List<String> enabledChannelsAsStrings()

      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnabledChannels() method.

      Returns:
      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.

      Returns:
      By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      An array of tags (key and value pairs) associated with the notify configuration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      An array of tags (key and value pairs) associated with the notify configuration.

    • toBuilder

      public CreateNotifyConfigurationRequest.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<CreateNotifyConfigurationRequest.Builder,CreateNotifyConfigurationRequest>
      Specified by:
      toBuilder in class PinpointSmsVoiceV2Request
      Returns:
      a builder for type T

    • builder

      public static CreateNotifyConfigurationRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.