com.amazonaws.services.servicediscovery.model.InstanceSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicediscovery Show documentation
/*
* Copyright 2019-2024 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 the instances that you registered by using a specified service.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InstanceSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID for an instance that you created by using a specified service.
*
*/
private String id;
/**
*
* A string map that contains the following information:
*
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,
* then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,
* example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,
* 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*
*/
private java.util.Map attributes;
/**
*
* The ID for an instance that you created by using a specified service.
*
*
* @param id
* The ID for an instance that you created by using a specified service.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The ID for an instance that you created by using a specified service.
*
*
* @return The ID for an instance that you created by using a specified service.
*/
public String getId() {
return this.id;
}
/**
*
* The ID for an instance that you created by using a specified service.
*
*
* @param id
* The ID for an instance that you created by using a specified service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceSummary withId(String id) {
setId(id);
return this;
}
/**
*
* A string map that contains the following information:
*
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,
* then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,
* example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,
* 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*
*
* @return A string map that contains the following information:
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is
* specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for
* example, example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for
* example, 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for
* example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*/
public java.util.Map getAttributes() {
return attributes;
}
/**
*
* A string map that contains the following information:
*
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,
* then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,
* example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,
* 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*
*
* @param attributes
* A string map that contains the following information:
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is
* specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for
* example, example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for
* example, 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for
* example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes;
}
/**
*
* A string map that contains the following information:
*
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,
* then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example,
* example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example,
* 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example,
* 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
*
*
* @param attributes
* A string map that contains the following information:
*
* -
*
* The attributes that are associated with the instance.
*
*
* -
*
* For each attribute, the applicable value.
*
*
*
*
* Supported attribute keys include the following:
*
*
* - AWS_ALIAS_DNS_NAME
* -
*
* For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
* associated with the load balancer.
*
*
* - AWS_EC2_INSTANCE_ID (HTTP namespaces only)
* -
*
* The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is
* specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.
*
*
* - AWS_INIT_HEALTH_STATUS
* -
*
* If the service configuration includes HealthCheckCustomConfig, you can optionally use
* AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
* HEALTHY or UNHEALTHY. If you don't specify a value for
* AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
*
*
* - AWS_INSTANCE_CNAME
* -
*
* For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for
* example, example.com).
*
*
* - AWS_INSTANCE_IPV4
* -
*
* For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for
* example, 192.0.2.44).
*
*
* - AWS_INSTANCE_IPV6
* -
*
* For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for
* example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).
*
*
* - AWS_INSTANCE_PORT
* -
*
* For an SRV record, the value that Route 53 returns for the port. In addition, if the service
* includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceSummary withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see InstanceSummary#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public InstanceSummary addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceSummary clearAttributesEntries() {
this.attributes = null;
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 (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InstanceSummary == false)
return false;
InstanceSummary other = (InstanceSummary) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == 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 + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
return hashCode;
}
@Override
public InstanceSummary clone() {
try {
return (InstanceSummary) 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.InstanceSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}