public class HttpAction
extends java.lang.Object
implements java.io.Serializable
Send data to an HTTPS endpoint.
Constructor and Description |
---|
HttpAction() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
HttpAuthorization |
getAuth()
The authentication method to use when sending data to an HTTPS endpoint.
|
java.lang.String |
getConfirmationUrl()
The URL to which AWS IoT sends a confirmation message.
|
java.util.List<HttpActionHeader> |
getHeaders()
The HTTP headers to send with the message data.
|
java.lang.String |
getUrl()
The endpoint URL.
|
int |
hashCode() |
void |
setAuth(HttpAuthorization auth)
The authentication method to use when sending data to an HTTPS endpoint.
|
void |
setConfirmationUrl(java.lang.String confirmationUrl)
The URL to which AWS IoT sends a confirmation message.
|
void |
setHeaders(java.util.Collection<HttpActionHeader> headers)
The HTTP headers to send with the message data.
|
void |
setUrl(java.lang.String url)
The endpoint URL.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
HttpAction |
withAuth(HttpAuthorization auth)
The authentication method to use when sending data to an HTTPS endpoint.
|
HttpAction |
withConfirmationUrl(java.lang.String confirmationUrl)
The URL to which AWS IoT sends a confirmation message.
|
HttpAction |
withHeaders(java.util.Collection<HttpActionHeader> headers)
The HTTP headers to send with the message data.
|
HttpAction |
withHeaders(HttpActionHeader... headers)
The HTTP headers to send with the message data.
|
HttpAction |
withUrl(java.lang.String url)
The endpoint URL.
|
public java.lang.String getUrl()
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.
Constraints:
Length: - 2000
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.
public void setUrl(java.lang.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.
Constraints:
Length: - 2000
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.
public HttpAction withUrl(java.lang.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 a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2000
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.
public java.lang.String getConfirmationUrl()
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 substitution template before traffic is allowed to your endpoint URL.
Constraints:
Length: - 2000
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 substitution template before traffic is allowed to your endpoint URL.
public void setConfirmationUrl(java.lang.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 substitution template before traffic is allowed to your endpoint URL.
Constraints:
Length: - 2000
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 substitution template before traffic is allowed to your endpoint URL.
public HttpAction withConfirmationUrl(java.lang.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 substitution template before traffic is allowed to your endpoint URL.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2000
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 substitution template before traffic is allowed to your endpoint URL.
public java.util.List<HttpActionHeader> getHeaders()
The HTTP headers to send with the message data.
The HTTP headers to send with the message data.
public void setHeaders(java.util.Collection<HttpActionHeader> headers)
The HTTP headers to send with the message data.
headers
- The HTTP headers to send with the message data.
public HttpAction withHeaders(HttpActionHeader... headers)
The HTTP headers to send with the message data.
Returns a reference to this object so that method calls can be chained together.
headers
- The HTTP headers to send with the message data.
public HttpAction withHeaders(java.util.Collection<HttpActionHeader> headers)
The HTTP headers to send with the message data.
Returns a reference to this object so that method calls can be chained together.
headers
- The HTTP headers to send with the message data.
public HttpAuthorization getAuth()
The authentication method to use when sending data to an HTTPS endpoint.
The authentication method to use when sending data to an HTTPS endpoint.
public void setAuth(HttpAuthorization auth)
The authentication method to use when sending data to an HTTPS endpoint.
auth
- The authentication method to use when sending data to an HTTPS endpoint.
public HttpAction withAuth(HttpAuthorization auth)
The authentication method to use when sending data to an HTTPS endpoint.
Returns a reference to this object so that method calls can be chained together.
auth
- The authentication method to use when sending data to an HTTPS endpoint.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.