Class Subscriber

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

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber has the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

See Also:

  • Method Details

    • subscriptionType

      public final SubscriptionType subscriptionType()

      The type of notification that Amazon Web Services sends to a subscriber.

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

      Returns:
      The type of notification that Amazon Web Services sends to a subscriber.
      See Also:

    • subscriptionTypeAsString

      public final String subscriptionTypeAsString()

      The type of notification that Amazon Web Services sends to a subscriber.

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

      Returns:
      The type of notification that Amazon Web Services sends to a subscriber.
      See Also:

    • address

      public final String address()

      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

      Returns:
      The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

      When you create a subscriber, the value of Address can't contain line breaks.

    • toBuilder

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

    • builder

      public static Subscriber.Builder builder()

    • serializableBuilderClass

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