TopicRuleDestination (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iot.model.TopicRuleDestination

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TopicRuleDestination.Builder,TopicRuleDestination>

@Generated(value="software.amazon.awssdk:codegen")
public final class TopicRuleDestination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TopicRuleDestination.Builder,TopicRuleDestination>

A topic rule destination.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TopicRuleDestination.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TopicRuleDestination.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The topic rule destination URL.
`static TopicRuleDestination.Builder`	`builder()`
`Instant`	`createdAt()` The date and time when the topic rule destination was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HttpUrlDestinationProperties`	`httpUrlProperties()` Properties of the HTTP URL.
`Instant`	`lastUpdatedAt()` The date and time when the topic rule destination was last updated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TopicRuleDestination.Builder>`	`serializableBuilderClass()`
`TopicRuleDestinationStatus`	`status()` The status of the topic rule destination.
`String`	`statusAsString()` The status of the topic rule destination.
`String`	`statusReason()` Additional details or reason why the topic rule destination is in the current status.
`TopicRuleDestination.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VpcDestinationProperties`	`vpcProperties()` Properties of the virtual private cloud (VPC) connection.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    TopicRuleDestinationStatus
  - 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:
    
    TopicRuleDestinationStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicRuleDestination.Builder,TopicRuleDestination>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class TopicRuleDestination

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

status

statusAsString

createdAt

lastUpdatedAt

statusReason

httpUrlProperties

vpcProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields