software.amazon.awssdk.services.iot.model

Interface TopicRuleDestination.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TopicRuleDestination.Builder,TopicRuleDestination>, SdkBuilder<TopicRuleDestination.Builder,TopicRuleDestination>, SdkPojo

Enclosing class:

TopicRuleDestination

public static interface TopicRuleDestination.Builder
extends SdkPojo, CopyableBuilder<TopicRuleDestination.Builder,TopicRuleDestination>

Method Summary

Modifier and Type	Method and Description
TopicRuleDestination.Builder	arn(String arn) The topic rule destination URL.
default TopicRuleDestination.Builder	httpUrlProperties(Consumer<HttpUrlDestinationProperties.Builder> httpUrlProperties) Properties of the HTTP URL.
TopicRuleDestination.Builder	httpUrlProperties(HttpUrlDestinationProperties httpUrlProperties) Properties of the HTTP URL.
TopicRuleDestination.Builder	status(String status) The status of the topic rule destination.
TopicRuleDestination.Builder	status(TopicRuleDestinationStatus status) The status of the topic rule destination.
TopicRuleDestination.Builder	statusReason(String statusReason) Additional details or reason why the topic rule destination is in the current status.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

arn

TopicRuleDestination.Builder arn(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.

status

TopicRuleDestination.Builder status(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, TopicRuleDestinationStatus

status

TopicRuleDestination.Builder status(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, TopicRuleDestinationStatus

statusReason

TopicRuleDestination.Builder statusReason(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.

httpUrlProperties

TopicRuleDestination.Builder httpUrlProperties(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.

httpUrlProperties

default TopicRuleDestination.Builder httpUrlProperties(Consumer<HttpUrlDestinationProperties.Builder> httpUrlProperties)

Properties of the HTTP URL.

This is a convenience that creates an instance of the HttpUrlDestinationProperties.Builder avoiding the need to create one manually via HttpUrlDestinationProperties.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpUrlProperties(HttpUrlDestinationProperties).

Parameters:

httpUrlProperties - a consumer that will call methods on HttpUrlDestinationProperties.Builder

Returns:

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

See Also:

httpUrlProperties(HttpUrlDestinationProperties)