public class UpdateHealthCheckRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
> A complex type that contains information about the request to update a health check.
NOOP
Constructor and Description |
---|
UpdateHealthCheckRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateHealthCheckRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
List<String> |
getChildHealthChecks()
For a specified parent health check, a list of
HealthCheckId
values for the associated child health checks. |
Integer |
getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa.
|
String |
getFullyQualifiedDomainName()
Fully qualified domain name of the instance to be health checked.
|
String |
getHealthCheckId()
The ID of the health check to update.
|
Long |
getHealthCheckVersion()
Optional.
|
Integer |
getHealthThreshold()
The minimum number of child health checks that must be healthy for Amazon
Route 53 to consider the parent health check to be healthy.
|
Boolean |
getInverted()
A boolean value that indicates whether the status of health check should
be inverted.
|
String |
getIPAddress()
The IP address of the resource that you want to check.
|
Integer |
getPort()
The port on which you want Amazon Route 53 to open a connection to
perform health checks.
|
String |
getResourcePath()
The path that you want Amazon Route 53 to request when performing health
checks.
|
String |
getSearchString()
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Amazon Route 53 to
search for in the response body from the specified resource. |
int |
hashCode() |
Boolean |
isInverted()
A boolean value that indicates whether the status of health check should
be inverted.
|
void |
setChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of
HealthCheckId
values for the associated child health checks. |
void |
setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa.
|
void |
setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
void |
setHealthCheckId(String healthCheckId)
The ID of the health check to update.
|
void |
setHealthCheckVersion(Long healthCheckVersion)
Optional.
|
void |
setHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for Amazon
Route 53 to consider the parent health check to be healthy.
|
void |
setInverted(Boolean inverted)
A boolean value that indicates whether the status of health check should
be inverted.
|
void |
setIPAddress(String iPAddress)
The IP address of the resource that you want to check.
|
void |
setPort(Integer port)
The port on which you want Amazon Route 53 to open a connection to
perform health checks.
|
void |
setResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing health
checks.
|
void |
setSearchString(String searchString)
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Amazon Route 53 to
search for in the response body from the specified resource. |
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateHealthCheckRequest |
withChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of
HealthCheckId
values for the associated child health checks. |
UpdateHealthCheckRequest |
withChildHealthChecks(String... childHealthChecks)
For a specified parent health check, a list of
HealthCheckId
values for the associated child health checks. |
UpdateHealthCheckRequest |
withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa.
|
UpdateHealthCheckRequest |
withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
|
UpdateHealthCheckRequest |
withHealthCheckId(String healthCheckId)
The ID of the health check to update.
|
UpdateHealthCheckRequest |
withHealthCheckVersion(Long healthCheckVersion)
Optional.
|
UpdateHealthCheckRequest |
withHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for Amazon
Route 53 to consider the parent health check to be healthy.
|
UpdateHealthCheckRequest |
withInverted(Boolean inverted)
A boolean value that indicates whether the status of health check should
be inverted.
|
UpdateHealthCheckRequest |
withIPAddress(String iPAddress)
The IP address of the resource that you want to check.
|
UpdateHealthCheckRequest |
withPort(Integer port)
The port on which you want Amazon Route 53 to open a connection to
perform health checks.
|
UpdateHealthCheckRequest |
withResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing health
checks.
|
UpdateHealthCheckRequest |
withSearchString(String searchString)
If the value of
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH , the string that you want Amazon Route 53 to
search for in the response body from the specified resource. |
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setHealthCheckId(String healthCheckId)
The ID of the health check to update.
healthCheckId
- The ID of the health check to update.public String getHealthCheckId()
The ID of the health check to update.
public UpdateHealthCheckRequest withHealthCheckId(String healthCheckId)
The ID of the health check to update.
healthCheckId
- The ID of the health check to update.public void setHealthCheckVersion(Long healthCheckVersion)
Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check, which
prevents you from updating the health check when the versions don't
match. Using HealthCheckVersion
lets you prevent overwriting
another change to the health check.
healthCheckVersion
- Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check,
which prevents you from updating the health check when the
versions don't match. Using HealthCheckVersion
lets
you prevent overwriting another change to the health check.public Long getHealthCheckVersion()
Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check, which
prevents you from updating the health check when the versions don't
match. Using HealthCheckVersion
lets you prevent overwriting
another change to the health check.
HealthCheckVersion
lets
you prevent overwriting another change to the health check.public UpdateHealthCheckRequest withHealthCheckVersion(Long healthCheckVersion)
Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check, which
prevents you from updating the health check when the versions don't
match. Using HealthCheckVersion
lets you prevent overwriting
another change to the health check.
healthCheckVersion
- Optional. When you specify a health check version, Amazon Route 53
compares this value with the current value in the health check,
which prevents you from updating the health check when the
versions don't match. Using HealthCheckVersion
lets
you prevent overwriting another change to the health check.public void setIPAddress(String iPAddress)
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
iPAddress
- The IP address of the resource that you want to check.
Specify this value only if you want to change it.
public String getIPAddress()
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withIPAddress(String iPAddress)
The IP address of the resource that you want to check.
Specify this value only if you want to change it.
iPAddress
- The IP address of the resource that you want to check.
Specify this value only if you want to change it.
public void setPort(Integer port)
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
port
- The port on which you want Amazon Route 53 to open a connection to
perform health checks.
Specify this value only if you want to change it.
public Integer getPort()
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withPort(Integer port)
The port on which you want Amazon Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
port
- The port on which you want Amazon Route 53 to open a connection to
perform health checks.
Specify this value only if you want to change it.
public void setResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
resourcePath
- The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint
will return an HTTP status code of 2xx or 3xx when the endpoint is
healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
public String getResourcePath()
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withResourcePath(String resourcePath)
The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
resourcePath
- The path that you want Amazon Route 53 to request when performing
health checks. The path can be any value for which your endpoint
will return an HTTP status code of 2xx or 3xx when the endpoint is
healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
fullyQualifiedDomainName
- Fully qualified domain name of the instance to be health
checked.
Specify this value only if you want to change it.
public String getFullyQualifiedDomainName()
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withFullyQualifiedDomainName(String fullyQualifiedDomainName)
Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
fullyQualifiedDomainName
- Fully qualified domain name of the instance to be health
checked.
Specify this value only if you want to change it.
public void setSearchString(String searchString)
If the value of Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want Amazon Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Amazon Route 53 considers the
resource healthy.
Specify this value only if you want to change it.
searchString
- If the value of Type
is HTTP_STR_MATCH
or HTTP_STR_MATCH
, the string that you want Amazon
Route 53 to search for in the response body from the specified
resource. If the string appears in the response body, Amazon Route
53 considers the resource healthy.
Specify this value only if you want to change it.
public String getSearchString()
If the value of Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want Amazon Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Amazon Route 53 considers the
resource healthy.
Specify this value only if you want to change it.
Type
is HTTP_STR_MATCH
or HTTP_STR_MATCH
, the string that you want Amazon
Route 53 to search for in the response body from the specified
resource. If the string appears in the response body, Amazon
Route 53 considers the resource healthy.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withSearchString(String searchString)
If the value of Type
is HTTP_STR_MATCH
or
HTTP_STR_MATCH
, the string that you want Amazon Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Amazon Route 53 considers the
resource healthy.
Specify this value only if you want to change it.
searchString
- If the value of Type
is HTTP_STR_MATCH
or HTTP_STR_MATCH
, the string that you want Amazon
Route 53 to search for in the response body from the specified
resource. If the string appears in the response body, Amazon Route
53 considers the resource healthy.
Specify this value only if you want to change it.
public void setFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
failureThreshold
- The number of consecutive health checks that an endpoint must pass
or fail for Amazon Route 53 to change the current status of the
endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public Integer getFailureThreshold()
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withFailureThreshold(Integer failureThreshold)
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
failureThreshold
- The number of consecutive health checks that an endpoint must pass
or fail for Amazon Route 53 to change the current status of the
endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
public void setInverted(Boolean inverted)
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
inverted
- A boolean value that indicates whether the status of health check
should be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
public Boolean getInverted()
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withInverted(Boolean inverted)
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
inverted
- A boolean value that indicates whether the status of health check
should be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
public Boolean isInverted()
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
Inverted
is True
, then Amazon Route 53
considers the health check to be unhealthy.
Specify this value only if you want to change it.
public void setHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
healthThreshold
- The minimum number of child health checks that must be healthy for
Amazon Route 53 to consider the parent health check to be healthy.
Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
public Integer getHealthThreshold()
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withHealthThreshold(Integer healthThreshold)
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
healthThreshold
- The minimum number of child health checks that must be healthy for
Amazon Route 53 to consider the parent health check to be healthy.
Valid values are integers between 0 and 256, inclusive.
Specify this value only if you want to change it.
public List<String> getChildHealthChecks()
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
HealthCheckId
values for the associated child health
checks.
Specify this value only if you want to change it.
public void setChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
childHealthChecks
- For a specified parent health check, a list of
HealthCheckId
values for the associated child health
checks.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withChildHealthChecks(String... childHealthChecks)
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
NOTE: This method appends the values to the existing list (if
any). Use setChildHealthChecks(java.util.Collection)
or
withChildHealthChecks(java.util.Collection)
if you want to
override the existing values.
childHealthChecks
- For a specified parent health check, a list of
HealthCheckId
values for the associated child health
checks.
Specify this value only if you want to change it.
public UpdateHealthCheckRequest withChildHealthChecks(Collection<String> childHealthChecks)
For a specified parent health check, a list of HealthCheckId
values for the associated child health checks.
Specify this value only if you want to change it.
childHealthChecks
- For a specified parent health check, a list of
HealthCheckId
values for the associated child health
checks.
Specify this value only if you want to change it.
public String toString()
toString
in class Object
Object.toString()
public UpdateHealthCheckRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.