com.amazonaws.services.servicediscovery.model.ServiceSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicediscovery Show documentation
/*
* Copyright 2017-2022 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.servicediscovery.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A complex type that contains information about a specified service.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ServiceSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID that Cloud Map assigned to the service when you created it.
*
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*
*/
private String arn;
/**
*
* The name of the service.
*
*/
private String name;
/**
*
* Describes the systems that can be used to discover the service instances.
*
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
*
*/
private String type;
/**
*
* The description that you specify when you create the service.
*
*/
private String description;
/**
*
* The number of instances that are currently associated with the service. Instances that were previously associated
* with the service but that are deleted aren't included in the count. The count might not reflect pending
* registrations and deregistrations.
*
*/
private Integer instanceCount;
/**
*
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
*
*/
private DnsConfig dnsConfig;
/**
*
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a
* health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
*
*/
private HealthCheckConfig healthCheckConfig;
/**
*
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
*
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
* HealthCheckConfig but not both.
*
*
*/
private HealthCheckCustomConfig healthCheckCustomConfig;
/**
*
* The date and time that the service was created.
*
*/
private java.util.Date createDate;
/**
*
* The ID that Cloud Map assigned to the service when you created it.
*
*
* @param id
* The ID that Cloud Map assigned to the service when you created it.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The ID that Cloud Map assigned to the service when you created it.
*
*
* @return The ID that Cloud Map assigned to the service when you created it.
*/
public String getId() {
return this.id;
}
/**
*
* The ID that Cloud Map assigned to the service when you created it.
*
*
* @param id
* The ID that Cloud Map assigned to the service when you created it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withId(String id) {
setId(id);
return this;
}
/**
*
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*
*
* @param arn
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*
*
* @return The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
*
*
* @param arn
* The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The name of the service.
*
*
* @param name
* The name of the service.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the service.
*
*
* @return The name of the service.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the service.
*
*
* @param name
* The name of the service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withName(String name) {
setName(name);
return this;
}
/**
*
* Describes the systems that can be used to discover the service instances.
*
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
*
*
* @param type
* Describes the systems that can be used to discover the service instances.
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
* @see ServiceType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Describes the systems that can be used to discover the service instances.
*
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
*
*
* @return Describes the systems that can be used to discover the service instances.
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances
* API operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
* @see ServiceType
*/
public String getType() {
return this.type;
}
/**
*
* Describes the systems that can be used to discover the service instances.
*
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
*
*
* @param type
* Describes the systems that can be used to discover the service instances.
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceType
*/
public ServiceSummary withType(String type) {
setType(type);
return this;
}
/**
*
* Describes the systems that can be used to discover the service instances.
*
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
*
*
* @param type
* Describes the systems that can be used to discover the service instances.
*
* - DNS_HTTP
* -
*
* The service instances can be discovered using either DNS queries or the DiscoverInstances API
* operation.
*
*
* - HTTP
* -
*
* The service instances can only be discovered using the DiscoverInstances API operation.
*
*
* - DNS
* -
*
* Reserved.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceType
*/
public ServiceSummary withType(ServiceType type) {
this.type = type.toString();
return this;
}
/**
*
* The description that you specify when you create the service.
*
*
* @param description
* The description that you specify when you create the service.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description that you specify when you create the service.
*
*
* @return The description that you specify when you create the service.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description that you specify when you create the service.
*
*
* @param description
* The description that you specify when you create the service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The number of instances that are currently associated with the service. Instances that were previously associated
* with the service but that are deleted aren't included in the count. The count might not reflect pending
* registrations and deregistrations.
*
*
* @param instanceCount
* The number of instances that are currently associated with the service. Instances that were previously
* associated with the service but that are deleted aren't included in the count. The count might not reflect
* pending registrations and deregistrations.
*/
public void setInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
}
/**
*
* The number of instances that are currently associated with the service. Instances that were previously associated
* with the service but that are deleted aren't included in the count. The count might not reflect pending
* registrations and deregistrations.
*
*
* @return The number of instances that are currently associated with the service. Instances that were previously
* associated with the service but that are deleted aren't included in the count. The count might not
* reflect pending registrations and deregistrations.
*/
public Integer getInstanceCount() {
return this.instanceCount;
}
/**
*
* The number of instances that are currently associated with the service. Instances that were previously associated
* with the service but that are deleted aren't included in the count. The count might not reflect pending
* registrations and deregistrations.
*
*
* @param instanceCount
* The number of instances that are currently associated with the service. Instances that were previously
* associated with the service but that are deleted aren't included in the count. The count might not reflect
* pending registrations and deregistrations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withInstanceCount(Integer instanceCount) {
setInstanceCount(instanceCount);
return this;
}
/**
*
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
*
*
* @param dnsConfig
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an
* instance.
*/
public void setDnsConfig(DnsConfig dnsConfig) {
this.dnsConfig = dnsConfig;
}
/**
*
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
*
*
* @return Information about the Route 53 DNS records that you want Cloud Map to create when you register an
* instance.
*/
public DnsConfig getDnsConfig() {
return this.dnsConfig;
}
/**
*
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
*
*
* @param dnsConfig
* Information about the Route 53 DNS records that you want Cloud Map to create when you register an
* instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withDnsConfig(DnsConfig dnsConfig) {
setDnsConfig(dnsConfig);
return this;
}
/**
*
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a
* health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
*
*
* @param healthCheckConfig
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings
* for a health check, Cloud Map associates the health check with the records that you specify in
* DnsConfig.
*/
public void setHealthCheckConfig(HealthCheckConfig healthCheckConfig) {
this.healthCheckConfig = healthCheckConfig;
}
/**
*
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a
* health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
*
*
* @return Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify
* settings for a health check, Cloud Map associates the health check with the records that you specify in
* DnsConfig.
*/
public HealthCheckConfig getHealthCheckConfig() {
return this.healthCheckConfig;
}
/**
*
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a
* health check, Cloud Map associates the health check with the records that you specify in DnsConfig.
*
*
* @param healthCheckConfig
* Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings
* for a health check, Cloud Map associates the health check with the records that you specify in
* DnsConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withHealthCheckConfig(HealthCheckConfig healthCheckConfig) {
setHealthCheckConfig(healthCheckConfig);
return this;
}
/**
*
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
*
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
* HealthCheckConfig but not both.
*
*
*
* @param healthCheckCustomConfig
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following
* circumstances:
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an
* Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig but not both.
*
*/
public void setHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) {
this.healthCheckCustomConfig = healthCheckCustomConfig;
}
/**
*
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
*
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
* HealthCheckConfig but not both.
*
*
*
* @return Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following
* circumstances:
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an
* Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig but not both.
*
*/
public HealthCheckCustomConfig getHealthCheckCustomConfig() {
return this.healthCheckCustomConfig;
}
/**
*
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
*
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
* HealthCheckConfig but not both.
*
*
*
* @param healthCheckCustomConfig
* Information about an optional custom health check. A custom health check, which requires that you use a
* third-party health checker to evaluate the health of your resources, is useful in the following
* circumstances:
*
* -
*
* You can't use a health check that's defined by HealthCheckConfig because the resource isn't
* available over the internet. For example, you can use a custom health check when the instance is in an
* Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
*
*
* -
*
* You want to use a third-party health checker regardless of where your resources are located.
*
*
*
*
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig but not both.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) {
setHealthCheckCustomConfig(healthCheckCustomConfig);
return this;
}
/**
*
* The date and time that the service was created.
*
*
* @param createDate
* The date and time that the service was created.
*/
public void setCreateDate(java.util.Date createDate) {
this.createDate = createDate;
}
/**
*
* The date and time that the service was created.
*
*
* @return The date and time that the service was created.
*/
public java.util.Date getCreateDate() {
return this.createDate;
}
/**
*
* The date and time that the service was created.
*
*
* @param createDate
* The date and time that the service was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ServiceSummary withCreateDate(java.util.Date createDate) {
setCreateDate(createDate);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getInstanceCount() != null)
sb.append("InstanceCount: ").append(getInstanceCount()).append(",");
if (getDnsConfig() != null)
sb.append("DnsConfig: ").append(getDnsConfig()).append(",");
if (getHealthCheckConfig() != null)
sb.append("HealthCheckConfig: ").append(getHealthCheckConfig()).append(",");
if (getHealthCheckCustomConfig() != null)
sb.append("HealthCheckCustomConfig: ").append(getHealthCheckCustomConfig()).append(",");
if (getCreateDate() != null)
sb.append("CreateDate: ").append(getCreateDate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ServiceSummary == false)
return false;
ServiceSummary other = (ServiceSummary) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getInstanceCount() == null ^ this.getInstanceCount() == null)
return false;
if (other.getInstanceCount() != null && other.getInstanceCount().equals(this.getInstanceCount()) == false)
return false;
if (other.getDnsConfig() == null ^ this.getDnsConfig() == null)
return false;
if (other.getDnsConfig() != null && other.getDnsConfig().equals(this.getDnsConfig()) == false)
return false;
if (other.getHealthCheckConfig() == null ^ this.getHealthCheckConfig() == null)
return false;
if (other.getHealthCheckConfig() != null && other.getHealthCheckConfig().equals(this.getHealthCheckConfig()) == false)
return false;
if (other.getHealthCheckCustomConfig() == null ^ this.getHealthCheckCustomConfig() == null)
return false;
if (other.getHealthCheckCustomConfig() != null && other.getHealthCheckCustomConfig().equals(this.getHealthCheckCustomConfig()) == false)
return false;
if (other.getCreateDate() == null ^ this.getCreateDate() == null)
return false;
if (other.getCreateDate() != null && other.getCreateDate().equals(this.getCreateDate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getInstanceCount() == null) ? 0 : getInstanceCount().hashCode());
hashCode = prime * hashCode + ((getDnsConfig() == null) ? 0 : getDnsConfig().hashCode());
hashCode = prime * hashCode + ((getHealthCheckConfig() == null) ? 0 : getHealthCheckConfig().hashCode());
hashCode = prime * hashCode + ((getHealthCheckCustomConfig() == null) ? 0 : getHealthCheckCustomConfig().hashCode());
hashCode = prime * hashCode + ((getCreateDate() == null) ? 0 : getCreateDate().hashCode());
return hashCode;
}
@Override
public ServiceSummary clone() {
try {
return (ServiceSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.servicediscovery.model.transform.ServiceSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}