software.amazon.awssdk.services.iot.model

Interface HttpAction.Builder

All Superinterfaces:

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

Enclosing class:

HttpAction

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

Method Summary

Modifier and Type	Method and Description
default HttpAction.Builder	auth(Consumer<HttpAuthorization.Builder> auth) The authentication method to use when sending data to an HTTPS endpoint.
HttpAction.Builder	auth(HttpAuthorization auth) The authentication method to use when sending data to an HTTPS endpoint.
HttpAction.Builder	confirmationUrl(String confirmationUrl) The URL to which AWS IoT sends a confirmation message.
HttpAction.Builder	headers(Collection<HttpActionHeader> headers) The HTTP headers to send with the message data.
HttpAction.Builder	headers(Consumer<HttpActionHeader.Builder>... headers) The HTTP headers to send with the message data.
HttpAction.Builder	headers(HttpActionHeader... headers) The HTTP headers to send with the message data.
HttpAction.Builder	url(String url) The endpoint URL.

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

url

HttpAction.Builder url(String url)

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Parameters:

url - The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

Returns:

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

confirmationUrl

HttpAction.Builder confirmationUrl(String confirmationUrl)

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substituion template before traffic is allowed to your endpoint URL.

Parameters:

confirmationUrl - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substituion template before traffic is allowed to your endpoint URL.

Returns:

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

headers

HttpAction.Builder headers(Collection<HttpActionHeader> headers)

The HTTP headers to send with the message data.

Parameters:

headers - The HTTP headers to send with the message data.

Returns:

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

headers

HttpAction.Builder headers(HttpActionHeader... headers)

The HTTP headers to send with the message data.

Parameters:

headers - The HTTP headers to send with the message data.

Returns:

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

headers

HttpAction.Builder headers(Consumer<HttpActionHeader.Builder>... headers)

The HTTP headers to send with the message data.

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

Parameters:

headers - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#headers(List)

auth

HttpAction.Builder auth(HttpAuthorization auth)

The authentication method to use when sending data to an HTTPS endpoint.

Parameters:

auth - The authentication method to use when sending data to an HTTPS endpoint.

Returns:

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

auth

default HttpAction.Builder auth(Consumer<HttpAuthorization.Builder> auth)

The authentication method to use when sending data to an HTTPS endpoint.

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

Parameters:

auth - a consumer that will call methods on HttpAuthorization.Builder

Returns:

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

See Also:

auth(HttpAuthorization)