Class SubscriberSummary

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

Summary of a subscriber, as returned by ListSubscribers.

See Also:

  • Method Details

    • subscriberArn

      public final String subscriberArn()
      Returns the value of the SubscriberArn property for this object.
      Returns:
      The value of the SubscriberArn property for this object.

    • name

      public final String name()
      Returns the value of the Name property for this object.
      Returns:
      The value of the Name property for this object.

    • eventBusArn

      public final String eventBusArn()
      Returns the value of the EventBusArn property for this object.
      Returns:
      The value of the EventBusArn property for this object.

    • targetArn

      public final String targetArn()
      Returns the value of the TargetArn property for this object.
      Returns:
      The value of the TargetArn property for this object.

    • type

      public final OrderingType type()
      Returns the value of the Type property for this object.

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

      Returns:
      The value of the Type property for this object.
      See Also:

    • typeAsString

      public final String typeAsString()
      Returns the value of the Type property for this object.

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

      Returns:
      The value of the Type property for this object.
      See Also:

    • revoked

      public final Boolean revoked()

      True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.

      Returns:
      True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.

    • state

      public final SubscriberState state()
      Returns the value of the State property for this object.

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

      Returns:
      The value of the State property for this object.
      See Also:

    • stateAsString

      public final String stateAsString()
      Returns the value of the State property for this object.

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

      Returns:
      The value of the State property for this object.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time the subscriber was created.

      Returns:
      The time the subscriber was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time the subscriber was last modified.

      Returns:
      The time the subscriber was last modified.

    • subscriberAccountId

      public final String subscriberAccountId()
      Returns the value of the SubscriberAccountId property for this object.
      Returns:
      The value of the SubscriberAccountId property for this object.

    • toBuilder

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

    • builder

      public static SubscriberSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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