com.amazonaws.services.route53.model.CreateHealthCheckRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-route53 Show documentation
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.route53.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* A complex type that contains the health check request information.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateHealthCheckRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck
* request without the risk of creating two identical health checks:
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and settings as a
* previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health
* check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a deleted
* health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an existing
* health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but settings
* identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*
*/
private String callerReference;
/**
*
* A complex type that contains settings for a new health check.
*
*/
private HealthCheckConfig healthCheckConfig;
/**
*
* A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck
* request without the risk of creating two identical health checks:
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and settings as a
* previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health
* check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a deleted
* health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an existing
* health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but settings
* identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*
*
* @param callerReference
* A unique string that identifies the request and that allows you to retry a failed
* CreateHealthCheck request without the risk of creating two identical health checks:
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and
* settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health
* check. If the health check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a
* deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists
* error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an
* existing health check but with different settings, Route 53 returns a
* HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but
* settings identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*/
public void setCallerReference(String callerReference) {
this.callerReference = callerReference;
}
/**
*
* A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck
* request without the risk of creating two identical health checks:
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and settings as a
* previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health
* check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a deleted
* health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an existing
* health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but settings
* identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*
*
* @return A unique string that identifies the request and that allows you to retry a failed
* CreateHealthCheck request without the risk of creating two identical health checks:
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and
* settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health
* check. If the health check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a
* deleted health check, regardless of the settings, Route 53 returns a
* HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an
* existing health check but with different settings, Route 53 returns a
* HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but
* settings identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*/
public String getCallerReference() {
return this.callerReference;
}
/**
*
* A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck
* request without the risk of creating two identical health checks:
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and settings as a
* previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health
* check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a deleted
* health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an existing
* health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but settings
* identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
*
*
* @param callerReference
* A unique string that identifies the request and that allows you to retry a failed
* CreateHealthCheck request without the risk of creating two identical health checks:
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference and
* settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health
* check. If the health check does exist, Route 53 returns the settings for the existing health check.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as a
* deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists
* error.
*
*
* -
*
* If you send a CreateHealthCheck request with the same CallerReference as an
* existing health check but with different settings, Route 53 returns a
* HealthCheckAlreadyExists error.
*
*
* -
*
* If you send a CreateHealthCheck request with a unique CallerReference but
* settings identical to an existing health check, Route 53 creates the health check.
*
*
*
*
* Route 53 does not store the CallerReference for a deleted health check indefinitely. The
* CallerReference for a deleted health check will be deleted after a number of days.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateHealthCheckRequest withCallerReference(String callerReference) {
setCallerReference(callerReference);
return this;
}
/**
*
* A complex type that contains settings for a new health check.
*
*
* @param healthCheckConfig
* A complex type that contains settings for a new health check.
*/
public void setHealthCheckConfig(HealthCheckConfig healthCheckConfig) {
this.healthCheckConfig = healthCheckConfig;
}
/**
*
* A complex type that contains settings for a new health check.
*
*
* @return A complex type that contains settings for a new health check.
*/
public HealthCheckConfig getHealthCheckConfig() {
return this.healthCheckConfig;
}
/**
*
* A complex type that contains settings for a new health check.
*
*
* @param healthCheckConfig
* A complex type that contains settings for a new health check.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateHealthCheckRequest withHealthCheckConfig(HealthCheckConfig healthCheckConfig) {
setHealthCheckConfig(healthCheckConfig);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCallerReference() != null)
sb.append("CallerReference: ").append(getCallerReference()).append(",");
if (getHealthCheckConfig() != null)
sb.append("HealthCheckConfig: ").append(getHealthCheckConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateHealthCheckRequest == false)
return false;
CreateHealthCheckRequest other = (CreateHealthCheckRequest) obj;
if (other.getCallerReference() == null ^ this.getCallerReference() == null)
return false;
if (other.getCallerReference() != null && other.getCallerReference().equals(this.getCallerReference()) == false)
return false;
if (other.getHealthCheckConfig() == null ^ this.getHealthCheckConfig() == null)
return false;
if (other.getHealthCheckConfig() != null && other.getHealthCheckConfig().equals(this.getHealthCheckConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCallerReference() == null) ? 0 : getCallerReference().hashCode());
hashCode = prime * hashCode + ((getHealthCheckConfig() == null) ? 0 : getHealthCheckConfig().hashCode());
return hashCode;
}
@Override
public CreateHealthCheckRequest clone() {
return (CreateHealthCheckRequest) super.clone();
}
}