/* * Copyright 2010-2023 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 com.amazonaws.AmazonWebServiceRequest; /** *
* Updates a topic rule destination. You use this to change the status, endpoint * URL, or confirmation URL of the destination. *
** Requires permission to access the UpdateTopicRuleDestination action. *
*/ public class UpdateTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable { /** ** The ARN of the topic rule destination. *
*/ private String arn; /** ** The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*/
private String status;
/**
*
* The ARN of the topic rule destination. *
* * @return* The ARN of the topic rule destination. *
*/ public String getArn() { return arn; } /** ** The ARN of the topic rule destination. *
* * @param arn* The ARN of the topic rule destination. *
*/ public void setArn(String arn) { this.arn = arn; } /** ** The ARN of the topic rule destination. *
** Returns a reference to this object so that method calls can be chained * together. * * @param arn
* The ARN of the topic rule destination. *
* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateTopicRuleDestinationRequest withArn(String arn) { this.arn = arn; return this; } /** ** The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*
* @return
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is
* allowed. You can set status to DISABLED
* by calling UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is
* not allowed. You can set status to
* ENABLED by calling
* UpdateTopicRuleDestination.
*
* 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.
*
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*
* @param status
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is
* allowed. You can set status to
* DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is
* not allowed. You can set status to
* ENABLED by calling
* UpdateTopicRuleDestination.
*
* 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.
*
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*
* @param status
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is
* allowed. You can set status to
* DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is
* not allowed. You can set status to
* ENABLED by calling
* UpdateTopicRuleDestination.
*
* 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.
*
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*
* @param status
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is
* allowed. You can set status to
* DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is
* not allowed. You can set status to
* ENABLED by calling
* UpdateTopicRuleDestination.
*
* 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.
*
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is allowed.
* You can set status to DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is not
* allowed. You can set status to ENABLED by
* calling UpdateTopicRuleDestination.
*
* 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, DELETING
*
* @param status
* The status of the topic rule destination. Valid values are: *
*
* 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.
*
* Confirmation was completed, and traffic to this destination is
* allowed. You can set status to
* DISABLED by calling
* UpdateTopicRuleDestination.
*
* Confirmation was completed, and traffic to this destination is
* not allowed. You can set status to
* ENABLED by calling
* UpdateTopicRuleDestination.
*
* 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.
*