TopicRuleDestinationSummary (AWS Java SDK for AWS IoT 1.11.678 API)

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Information about the topic rule destination.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

TopicRuleDestinationSummary()

Constructors
Constructor and Description
`TopicRuleDestinationSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TopicRuleDestinationSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The topic rule destination ARN.
`HttpUrlDestinationSummary`	`getHttpUrlSummary()` Information about the HTTP URL.
`String`	`getStatus()` The status of the topic rule destination.
`String`	`getStatusReason()` The reason the topic rule destination is in the current status.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setArn(String arn)` The topic rule destination ARN.
`void`	`setHttpUrlSummary(HttpUrlDestinationSummary httpUrlSummary)` Information about the HTTP URL.
`void`	`setStatus(String status)` The status of the topic rule destination.
`void`	`setStatusReason(String statusReason)` The reason the topic rule destination is in the current status.
`String`	`toString()` Returns a string representation of this object.
`TopicRuleDestinationSummary`	`withArn(String arn)` The topic rule destination ARN.
`TopicRuleDestinationSummary`	`withHttpUrlSummary(HttpUrlDestinationSummary httpUrlSummary)` Information about the HTTP URL.
`TopicRuleDestinationSummary`	`withStatus(String status)` The status of the topic rule destination.
`TopicRuleDestinationSummary`	`withStatus(TopicRuleDestinationStatus status)` The status of the topic rule destination.
`TopicRuleDestinationSummary`	`withStatusReason(String statusReason)` The reason the topic rule destination is in the current status.

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

- Constructor Detail
  - TopicRuleDestinationSummary
```
public TopicRuleDestinationSummary()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The topic rule destination ARN.
    
    Parameters:
    
    arn - The topic rule destination ARN.
  - getArn
```
public String getArn()
```
    The topic rule destination ARN.
    
    Returns:
    
    The topic rule destination ARN.
  - withArn
```
public TopicRuleDestinationSummary withArn(String arn)
```
    The topic rule destination ARN.
    
    Parameters:
    
    arn - The topic rule destination ARN.
    
    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 TopicRuleDestinationSummary 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 TopicRuleDestinationSummary 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)
```
    The reason the topic rule destination is in the current status.
    
    Parameters:
    
    statusReason - The reason the topic rule destination is in the current status.
  - getStatusReason
```
public String getStatusReason()
```
    The reason the topic rule destination is in the current status.
    
    Returns:
    
    The reason the topic rule destination is in the current status.
  - withStatusReason
```
public TopicRuleDestinationSummary withStatusReason(String statusReason)
```
    The reason the topic rule destination is in the current status.
    
    Parameters:
    
    statusReason - The reason the topic rule destination is in the current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHttpUrlSummary
```
public void setHttpUrlSummary(HttpUrlDestinationSummary httpUrlSummary)
```
    Information about the HTTP URL.
    
    Parameters:
    
    httpUrlSummary - Information about the HTTP URL.
  - getHttpUrlSummary
```
public HttpUrlDestinationSummary getHttpUrlSummary()
```
    Information about the HTTP URL.
    
    Returns:
    
    Information about the HTTP URL.
  - withHttpUrlSummary
```
public TopicRuleDestinationSummary withHttpUrlSummary(HttpUrlDestinationSummary httpUrlSummary)
```
    Information about the HTTP URL.
    
    Parameters:
    
    httpUrlSummary - Information about 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 TopicRuleDestinationSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TopicRuleDestinationSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopicRuleDestinationSummary

Method Detail

setArn

getArn

withArn

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setHttpUrlSummary

getHttpUrlSummary

withHttpUrlSummary

toString

equals

hashCode

clone

marshall