com.amazonaws.services.iot.model

Class TopicRuleDestination

java.lang.Object

com.amazonaws.services.iot.model.TopicRuleDestination

All Implemented Interfaces:

Serializable

public class TopicRuleDestination
extends Object
implements Serializable

A topic rule destination.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TopicRuleDestination()

Method Summary

Modifier and Type	Method and Description
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	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	setStatus(TopicRuleDestinationStatus 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; useful for testing and debugging.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TopicRuleDestination

public TopicRuleDestination()

Method Detail

getArn

public String getArn()

The topic rule destination URL.

Returns:

The topic rule destination URL.

setArn

public void setArn(String arn)

The topic rule destination URL.

Parameters:

arn -

The topic rule destination URL.

withArn

public TopicRuleDestination withArn(String arn)

The topic rule destination URL.

Returns a reference to this object so that method calls can be chained together.

Parameters:

arn -

The topic rule destination URL.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR

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

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.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR

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

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR

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:

A reference to this updated object so that method calls can be chained together.

See Also:

TopicRuleDestinationStatus

setStatus

public void setStatus(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.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR

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

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ENABLED, IN_PROGRESS, DISABLED, ERROR

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:

A reference to this updated object so that method calls can be chained together.

See Also:

TopicRuleDestinationStatus

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.

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.

withStatusReason

public TopicRuleDestination withStatusReason(String statusReason)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

statusReason -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getHttpUrlProperties

public HttpUrlDestinationProperties getHttpUrlProperties()

Properties of the HTTP URL.

Returns:

Properties of the HTTP URL.

setHttpUrlProperties

public void setHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)

Properties of the HTTP URL.

Parameters:

httpUrlProperties -

Properties of the HTTP URL.

withHttpUrlProperties

public TopicRuleDestination withHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties)

Properties of the HTTP URL.

Returns a reference to this object so that method calls can be chained together.

Parameters:

httpUrlProperties -

Properties of the HTTP URL.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object