Package software.amazon.awssdk.services.pinpoint.model

Class OpenHours

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.OpenHours
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OpenHours.Builder,OpenHours>
@Generated("software.amazon.awssdk:codegen") public final class OpenHours extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OpenHours.Builder,OpenHours>

Specifies the times when message are allowed to be sent to endpoints.

See Also:

  • Method Details

    • email

      public final Map<DayOfWeek,List<OpenHoursRule>> email()

      Specifies the schedule settings for the email channel.

      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 hasEmail() method.

      Returns:
      Specifies the schedule settings for the email channel.

    • hasEmail

      public final boolean hasEmail()
      For responses, this returns true if the service returned a value for the EMAIL 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.

    • emailAsStrings

      public final Map<String,List<OpenHoursRule>> emailAsStrings()

      Specifies the schedule settings for the email channel.

      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 hasEmail() method.

      Returns:
      Specifies the schedule settings for the email channel.

    • sms

      public final Map<DayOfWeek,List<OpenHoursRule>> sms()

      Specifies the schedule settings for the SMS channel.

      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 hasSms() method.

      Returns:
      Specifies the schedule settings for the SMS channel.

    • hasSms

      public final boolean hasSms()
      For responses, this returns true if the service returned a value for the SMS 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.

    • smsAsStrings

      public final Map<String,List<OpenHoursRule>> smsAsStrings()

      Specifies the schedule settings for the SMS channel.

      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 hasSms() method.

      Returns:
      Specifies the schedule settings for the SMS channel.

    • push

      public final Map<DayOfWeek,List<OpenHoursRule>> push()

      Specifies the schedule settings for the push channel.

      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 hasPush() method.

      Returns:
      Specifies the schedule settings for the push channel.

    • hasPush

      public final boolean hasPush()
      For responses, this returns true if the service returned a value for the PUSH 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.

    • pushAsStrings

      public final Map<String,List<OpenHoursRule>> pushAsStrings()

      Specifies the schedule settings for the push channel.

      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 hasPush() method.

      Returns:
      Specifies the schedule settings for the push channel.

    • voice

      public final Map<DayOfWeek,List<OpenHoursRule>> voice()

      Specifies the schedule settings for the voice channel.

      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 hasVoice() method.

      Returns:
      Specifies the schedule settings for the voice channel.

    • hasVoice

      public final boolean hasVoice()
      For responses, this returns true if the service returned a value for the VOICE 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.

    • voiceAsStrings

      public final Map<String,List<OpenHoursRule>> voiceAsStrings()

      Specifies the schedule settings for the voice channel.

      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 hasVoice() method.

      Returns:
      Specifies the schedule settings for the voice channel.

    • custom

      public final Map<DayOfWeek,List<OpenHoursRule>> custom()

      Specifies the schedule settings for the custom channel.

      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 hasCustom() method.

      Returns:
      Specifies the schedule settings for the custom channel.

    • hasCustom

      public final boolean hasCustom()
      For responses, this returns true if the service returned a value for the CUSTOM 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.

    • customAsStrings

      public final Map<String,List<OpenHoursRule>> customAsStrings()

      Specifies the schedule settings for the custom channel.

      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 hasCustom() method.

      Returns:
      Specifies the schedule settings for the custom channel.

    • toBuilder

      public OpenHours.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<OpenHours.Builder,OpenHours>
      Returns:
      a builder for type T

    • builder

      public static OpenHours.Builder builder()

    • serializableBuilderClass

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