/* * Copyright 2018-2023 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.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateServiceRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name that you want to assign to the service. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using a
* system that requires a specific SRV
format, such as HAProxy,
* specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the record by
* concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ only * by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services * that with names that differ only by case. *
*
* The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it
* can be specified either here or in the DnsConfig
object.
*
* A unique string that identifies the request and that allows failed CreateService
requests to be
* retried without the risk of running the operation twice. CreatorRequestId
can be any unique string
* (for example, a date/timestamp).
*
* A description for the service. *
*/ private String description; /** ** A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when * you register an instance. *
*/ private DnsConfig dnsConfig; /** *
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health
* check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53
* DNS records that you specify in DnsConfig
.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud * Map Pricing. *
*/ private HealthCheckConfig healthCheckConfig; /** ** A complex type that contains information about an optional custom health check. *
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing service.
*
* The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can * be up to 128 characters in length, and tag values can be up to 256 characters in length. *
*/ private java.util.List
* If present, specifies that the service instances are only discoverable using the DiscoverInstances
* API operation. No DNS records is registered for the service instances. The only valid value is HTTP
.
*
* The name that you want to assign to the service. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using a
* system that requires a specific SRV
format, such as HAProxy,
* specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the record by
* concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ only * by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services * that with names that differ only by case. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using
* a system that requires a specific SRV
format, such as HAProxy, specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the
* record by concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ * only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create * services that with names that differ only by case. *
*/ public void setName(String name) { this.name = name; } /** ** The name that you want to assign to the service. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using a
* system that requires a specific SRV
format, such as HAProxy,
* specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the record by
* concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ only * by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services * that with names that differ only by case. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using
* a system that requires a specific SRV
format, such as HAProxy, specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the
* record by concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that * differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and * can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can * create services that with names that differ only by case. *
*/ public String getName() { return this.name; } /** ** The name that you want to assign to the service. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using a
* system that requires a specific SRV
format, such as HAProxy,
* specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the record by
* concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ only * by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services * that with names that differ only by case. *
** Do not include sensitive information in the name if the namespace is discoverable by public DNS queries. *
*
* If you want Cloud Map to create an SRV
record when you register an instance and you're using
* a system that requires a specific SRV
format, such as HAProxy, specify the following for Name
:
*
* Start the name with an underscore (_), such as _exampleservice
.
*
* End the name with ._protocol, such as ._tcp
.
*
* When you register an instance, Cloud Map creates an SRV
record and assigns a name to the
* record by concatenating the service name and the namespace name (for example,
*
* _exampleservice._tcp.example.com
).
*
* For services that are accessible by DNS queries, you can't create multiple services with names that differ * only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be * distinguished. However, if you use a namespace that's only accessible by API calls, then you can create * services that with names that differ only by case. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateServiceRequest withName(String name) { setName(name); return this; } /** *
* The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it
* can be specified either here or in the DnsConfig
object.
*
DnsConfig
object.
*/
public void setNamespaceId(String namespaceId) {
this.namespaceId = namespaceId;
}
/**
*
* The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it
* can be specified either here or in the DnsConfig
object.
*
DnsConfig
object.
*/
public String getNamespaceId() {
return this.namespaceId;
}
/**
*
* The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but it
* can be specified either here or in the DnsConfig
object.
*
DnsConfig
object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withNamespaceId(String namespaceId) {
setNamespaceId(namespaceId);
return this;
}
/**
*
* A unique string that identifies the request and that allows failed CreateService
requests to be
* retried without the risk of running the operation twice. CreatorRequestId
can be any unique string
* (for example, a date/timestamp).
*
CreateService
requests to
* be retried without the risk of running the operation twice. CreatorRequestId
can be any
* unique string (for example, a date/timestamp).
*/
public void setCreatorRequestId(String creatorRequestId) {
this.creatorRequestId = creatorRequestId;
}
/**
*
* A unique string that identifies the request and that allows failed CreateService
requests to be
* retried without the risk of running the operation twice. CreatorRequestId
can be any unique string
* (for example, a date/timestamp).
*
CreateService
requests to
* be retried without the risk of running the operation twice. CreatorRequestId
can be any
* unique string (for example, a date/timestamp).
*/
public String getCreatorRequestId() {
return this.creatorRequestId;
}
/**
*
* A unique string that identifies the request and that allows failed CreateService
requests to be
* retried without the risk of running the operation twice. CreatorRequestId
can be any unique string
* (for example, a date/timestamp).
*
CreateService
requests to
* be retried without the risk of running the operation twice. CreatorRequestId
can be any
* unique string (for example, a date/timestamp).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withCreatorRequestId(String creatorRequestId) {
setCreatorRequestId(creatorRequestId);
return this;
}
/**
* * A description for the service. *
* * @param description * A description for the service. */ public void setDescription(String description) { this.description = description; } /** ** A description for the service. *
* * @return A description for the service. */ public String getDescription() { return this.description; } /** ** A description for the service. *
* * @param description * A description for the service. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServiceRequest withDescription(String description) { setDescription(description); return this; } /** ** A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when * you register an instance. *
* * @param dnsConfig * A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to * create when you register an instance. */ public void setDnsConfig(DnsConfig dnsConfig) { this.dnsConfig = dnsConfig; } /** ** A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when * you register an instance. *
* * @return A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to * create when you register an instance. */ public DnsConfig getDnsConfig() { return this.dnsConfig; } /** ** A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create when * you register an instance. *
* * @param dnsConfig * A complex type that contains information about the Amazon Route 53 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 CreateServiceRequest withDnsConfig(DnsConfig dnsConfig) { setDnsConfig(dnsConfig); return this; } /** *
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health
* check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53
* DNS records that you specify in DnsConfig
.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud * Map Pricing. *
* * @param healthCheckConfig * Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 * health check. If you specify settings for a health check, Cloud Map associates the health check with all * the Route 53 DNS records that you specify inDnsConfig
.
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud Map Pricing. */ public void setHealthCheckConfig(HealthCheckConfig healthCheckConfig) { this.healthCheckConfig = healthCheckConfig; } /** *
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health
* check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53
* DNS records that you specify in DnsConfig
.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud * Map Pricing. *
* * @return Public DNS and HTTP namespaces only. A complex type that contains settings for an optional * Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check * with all the Route 53 DNS records that you specify inDnsConfig
.
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud Map Pricing. */ public HealthCheckConfig getHealthCheckConfig() { return this.healthCheckConfig; } /** *
* Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health
* check. If you specify settings for a health check, Cloud Map associates the health check with all the Route 53
* DNS records that you specify in DnsConfig
.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud * Map Pricing. *
* * @param healthCheckConfig * Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 * health check. If you specify settings for a health check, Cloud Map associates the health check with all * the Route 53 DNS records that you specify inDnsConfig
.
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* For information about the charges for health checks, see Cloud Map Pricing. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServiceRequest withHealthCheckConfig(HealthCheckConfig healthCheckConfig) { setHealthCheckConfig(healthCheckConfig); return this; } /** *
* A complex type that contains information about an optional custom health check. *
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing service.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing
* service.
*/
public void setHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) {
this.healthCheckCustomConfig = healthCheckCustomConfig;
}
/**
*
* A complex type that contains information about an optional custom health check. *
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing service.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing
* service.
*/
public HealthCheckCustomConfig getHealthCheckCustomConfig() {
return this.healthCheckCustomConfig;
}
/**
*
* A complex type that contains information about an optional custom health check. *
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or
* HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing service.
*
* If you specify a health check configuration, you can specify either HealthCheckCustomConfig
* or HealthCheckConfig
but not both.
*
* You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing
* service.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceRequest withHealthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) {
setHealthCheckCustomConfig(healthCheckCustomConfig);
return this;
}
/**
*
* The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can * be up to 128 characters in length, and tag values can be up to 256 characters in length. *
* * @return The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags * keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. */ public java.util.List* The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can * be up to 128 characters in length, and tag values can be up to 256 characters in length. *
* * @param tags * The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags * keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. */ public void setTags(java.util.Collection* The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can * be up to 128 characters in length, and tag values can be up to 256 characters in length. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags * keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServiceRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags keys can * be up to 128 characters in length, and tag values can be up to 256 characters in length. *
* * @param tags * The tags to add to the service. Each tag consists of a key and an optional value that you define. Tags * keys can be up to 128 characters in length, and tag values can be up to 256 characters in length. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServiceRequest withTags(java.util.Collection
* If present, specifies that the service instances are only discoverable using the DiscoverInstances
* API operation. No DNS records is registered for the service instances. The only valid value is HTTP
.
*
DiscoverInstances
API operation. No DNS records is registered for the service instances. The
* only valid value is HTTP
.
* @see ServiceTypeOption
*/
public void setType(String type) {
this.type = type;
}
/**
*
* If present, specifies that the service instances are only discoverable using the DiscoverInstances
* API operation. No DNS records is registered for the service instances. The only valid value is HTTP
.
*
DiscoverInstances
API operation. No DNS records is registered for the service instances. The
* only valid value is HTTP
.
* @see ServiceTypeOption
*/
public String getType() {
return this.type;
}
/**
*
* If present, specifies that the service instances are only discoverable using the DiscoverInstances
* API operation. No DNS records is registered for the service instances. The only valid value is HTTP
.
*
DiscoverInstances
API operation. No DNS records is registered for the service instances. The
* only valid value is HTTP
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceTypeOption
*/
public CreateServiceRequest withType(String type) {
setType(type);
return this;
}
/**
*
* If present, specifies that the service instances are only discoverable using the DiscoverInstances
* API operation. No DNS records is registered for the service instances. The only valid value is HTTP
.
*
DiscoverInstances
API operation. No DNS records is registered for the service instances. The
* only valid value is HTTP
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceTypeOption
*/
public CreateServiceRequest withType(ServiceTypeOption type) {
this.type = type.toString();
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getNamespaceId() != null)
sb.append("NamespaceId: ").append(getNamespaceId()).append(",");
if (getCreatorRequestId() != null)
sb.append("CreatorRequestId: ").append(getCreatorRequestId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).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 (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateServiceRequest == false)
return false;
CreateServiceRequest other = (CreateServiceRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getNamespaceId() == null ^ this.getNamespaceId() == null)
return false;
if (other.getNamespaceId() != null && other.getNamespaceId().equals(this.getNamespaceId()) == false)
return false;
if (other.getCreatorRequestId() == null ^ this.getCreatorRequestId() == null)
return false;
if (other.getCreatorRequestId() != null && other.getCreatorRequestId().equals(this.getCreatorRequestId()) == 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.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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getNamespaceId() == null) ? 0 : getNamespaceId().hashCode());
hashCode = prime * hashCode + ((getCreatorRequestId() == null) ? 0 : getCreatorRequestId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().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 + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public CreateServiceRequest clone() {
return (CreateServiceRequest) super.clone();
}
}