TopicRuleDestination (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.TopicRuleDestination

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TopicRuleDestination
extends Object
implements Serializable, Cloneable, StructuredPojo

A topic rule destination.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicRuleDestination()

Constructors
Constructor and Description
`TopicRuleDestination()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicRuleDestination`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The topic rule destination URL.
`HttpUrlDestinationProperties`	`getHttpUrlProperties()` Properties of the HTTP URL.
`String`	`getStatus()` The status of the topic rule destination.
`String`	`getStatusReason()` Additional details or reason why the topic rule destination is in the current status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The topic rule destination URL.
`void`	`setHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)` Properties of the HTTP URL.
`void`	`setStatus(String status)` The status of the topic rule destination.
`void`	`setStatusReason(String statusReason)` Additional details or reason why the topic rule destination is in the current status.
`String`	`toString()` Returns a string representation of this object.
`TopicRuleDestination`	`withArn(String arn)` The topic rule destination URL.
`TopicRuleDestination`	`withHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)` Properties of the HTTP URL.
`TopicRuleDestination`	`withStatus(String status)` The status of the topic rule destination.
`TopicRuleDestination`	`withStatus(TopicRuleDestinationStatus status)` The status of the topic rule destination.
`TopicRuleDestination`	`withStatusReason(String statusReason)` Additional details or reason why the topic rule destination is in the current status.

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

- Constructor Detail
  - TopicRuleDestination
```
public TopicRuleDestination()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The topic rule destination URL.
    
    Parameters:
    
    arn - The topic rule destination URL.
  - getArn
```
public String getArn()
```
    The topic rule destination URL.
    
    Returns:
    
    The topic rule destination URL.
  - withArn
```
public TopicRuleDestination withArn(String arn)
```
    The topic rule destination URL.
    
    Parameters:
    
    arn - The topic rule destination URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    TopicRuleDestinationStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    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
  - withStatus
```
public TopicRuleDestination withStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TopicRuleDestinationStatus
  - withStatus
```
public TopicRuleDestination withStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TopicRuleDestinationStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    Additional details or reason why the topic rule destination is in the current status.
    
    Parameters:
    
    statusReason - Additional details or reason why the topic rule destination is in the current status.
  - getStatusReason
```
public String getStatusReason()
```
    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.
  - withStatusReason
```
public TopicRuleDestination withStatusReason(String statusReason)
```
    Additional details or reason why the topic rule destination is in the current status.
    
    Parameters:
    
    statusReason - Additional details or reason why the topic rule destination is in the current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHttpUrlProperties
```
public void setHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)
```
    Properties of the HTTP URL.
    
    Parameters:
    
    httpUrlProperties - Properties of the HTTP URL.
  - getHttpUrlProperties
```
public HttpUrlDestinationProperties getHttpUrlProperties()
```
    Properties of the HTTP URL.
    
    Returns:
    
    Properties of the HTTP URL.
  - withHttpUrlProperties
```
public TopicRuleDestination withHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)
```
    Properties of the HTTP URL.
    
    Parameters:
    
    httpUrlProperties - Properties of the HTTP URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TopicRuleDestination clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TopicRuleDestination

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicRuleDestination

Method Detail

setArn

getArn

withArn

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setHttpUrlProperties

getHttpUrlProperties

withHttpUrlProperties

toString

equals

hashCode

clone

marshall