Class TopicRuleDestination

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

A topic rule destination.

See Also:

  • Method Details

    • arn

      public final String arn()

      The topic rule destination URL.

      Returns:
      The topic rule destination URL.

    • status

      public final TopicRuleDestinationStatus status()

      The status of the topic rule destination. Valid values are:

      IN_PROGRESS

      A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      ENABLED

      Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

      DISABLED

      Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

      ERROR

      Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

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

      Returns:
      The status of the topic rule destination. Valid values are:

      IN_PROGRESS

      A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      ENABLED

      Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

      DISABLED

      Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

      ERROR

      Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the topic rule destination. Valid values are:

      IN_PROGRESS

      A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      ENABLED

      Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

      DISABLED

      Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

      ERROR

      Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

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

      Returns:
      The status of the topic rule destination. Valid values are:

      IN_PROGRESS

      A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      ENABLED

      Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

      DISABLED

      Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

      ERROR

      Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time when the topic rule destination was created.

      Returns:
      The date and time when the topic rule destination was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the topic rule destination was last updated.

      Returns:
      The date and time when the topic rule destination was last updated.

    • statusReason

      public final String statusReason()

      Additional details or reason why the topic rule destination is in the current status.

      Returns:
      Additional details or reason why the topic rule destination is in the current status.

    • httpUrlProperties

      public final HttpUrlDestinationProperties httpUrlProperties()

      Properties of the HTTP URL.

      Returns:
      Properties of the HTTP URL.

    • vpcProperties

      public final VpcDestinationProperties vpcProperties()

      Properties of the virtual private cloud (VPC) connection.

      Returns:
      Properties of the virtual private cloud (VPC) connection.

    • toBuilder

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

    • builder

      public static TopicRuleDestination.Builder builder()

    • serializableBuilderClass

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