com.amazonaws.services.iot.model.TopicRuleDestination Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iot.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A topic rule destination.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TopicRuleDestination implements Serializable, Cloneable, StructuredPojo {
/**
*
* The topic rule destination URL.
*
*/
private String arn;
/**
*
* 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.
*
*
*
*/
private String status;
/**
*
* Additional details or reason why the topic rule destination is in the current status.
*
*/
private String statusReason;
/**
*
* Properties of the HTTP URL.
*
*/
private HttpUrlDestinationProperties httpUrlProperties;
/**
*
* The topic rule destination URL.
*
*
* @param arn
* The topic rule destination URL.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The topic rule destination URL.
*
*
* @return The topic rule destination URL.
*/
public String getArn() {
return this.arn;
}
/**
*
* The topic rule destination URL.
*
*
* @param arn
* The topic rule destination URL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TopicRuleDestination withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 TopicRuleDestinationStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
*
*
* @return 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 TopicRuleDestinationStatus
*/
public String getStatus() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TopicRuleDestinationStatus
*/
public TopicRuleDestination withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TopicRuleDestinationStatus
*/
public TopicRuleDestination withStatus(TopicRuleDestinationStatus status) {
this.status = status.toString();
return this;
}
/**
*
* Additional details or reason why the topic rule destination is in the current status.
*
*
* @param statusReason
* Additional details or reason why the topic rule destination is in the current status.
*/
public void setStatusReason(String statusReason) {
this.statusReason = statusReason;
}
/**
*
* Additional details or reason why the topic rule destination is in the current status.
*
*
* @return Additional details or reason why the topic rule destination is in the current status.
*/
public String getStatusReason() {
return this.statusReason;
}
/**
*
* Additional details or reason why the topic rule destination is in the current status.
*
*
* @param statusReason
* Additional details or reason why the topic rule destination is in the current status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TopicRuleDestination withStatusReason(String statusReason) {
setStatusReason(statusReason);
return this;
}
/**
*
* Properties of the HTTP URL.
*
*
* @param httpUrlProperties
* Properties of the HTTP URL.
*/
public void setHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties) {
this.httpUrlProperties = httpUrlProperties;
}
/**
*
* Properties of the HTTP URL.
*
*
* @return Properties of the HTTP URL.
*/
public HttpUrlDestinationProperties getHttpUrlProperties() {
return this.httpUrlProperties;
}
/**
*
* Properties of the HTTP URL.
*
*
* @param httpUrlProperties
* Properties of the HTTP URL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TopicRuleDestination withHttpUrlProperties(HttpUrlDestinationProperties httpUrlProperties) {
setHttpUrlProperties(httpUrlProperties);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusReason() != null)
sb.append("StatusReason: ").append(getStatusReason()).append(",");
if (getHttpUrlProperties() != null)
sb.append("HttpUrlProperties: ").append(getHttpUrlProperties());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TopicRuleDestination == false)
return false;
TopicRuleDestination other = (TopicRuleDestination) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusReason() == null ^ this.getStatusReason() == null)
return false;
if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false)
return false;
if (other.getHttpUrlProperties() == null ^ this.getHttpUrlProperties() == null)
return false;
if (other.getHttpUrlProperties() != null && other.getHttpUrlProperties().equals(this.getHttpUrlProperties()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode());
hashCode = prime * hashCode + ((getHttpUrlProperties() == null) ? 0 : getHttpUrlProperties().hashCode());
return hashCode;
}
@Override
public TopicRuleDestination clone() {
try {
return (TopicRuleDestination) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.iot.model.transform.TopicRuleDestinationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}