software.amazon.awssdk.services.iot.model

Class HttpAction

java.lang.Object

software.amazon.awssdk.services.iot.model.HttpAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HttpAction.Builder,HttpAction>

@Generated(value="software.amazon.awssdk:codegen")
public final class HttpAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HttpAction.Builder,HttpAction>

Send data to an HTTPS endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpAction.Builder

Method Summary

Modifier and Type	Method and Description
HttpAuthorization	auth() The authentication method to use when sending data to an HTTPS endpoint.
static HttpAction.Builder	builder()
String	confirmationUrl() The URL to which AWS IoT sends a confirmation message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHeaders() Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<HttpActionHeader>	headers() The HTTP headers to send with the message data.
List<SdkField<?>>	sdkFields()
static Class<? extends HttpAction.Builder>	serializableBuilderClass()
HttpAction.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The endpoint URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

url

public 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.

Returns:

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.

confirmationUrl

public 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.

Returns:

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.

hasHeaders

public boolean hasHeaders()

Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

headers

public List<HttpActionHeader> headers()

The HTTP headers to send with the message data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHeaders() to see if a value was sent in this field.

Returns:

The HTTP headers to send with the message data.

auth

public HttpAuthorization auth()

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

Returns:

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

toBuilder

public HttpAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HttpAction.Builder,HttpAction>

builder

public static HttpAction.Builder builder()

serializableBuilderClass

public static Class<? extends HttpAction.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo