Class Service
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Service.Builder,
Service>
A complex type that contains information about the specified service.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.static Service.Builder
builder()
final Instant
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC).final String
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.final String
The description of the service.final DnsConfig
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final HealthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.final HealthCheckCustomConfig
A complex type that contains information about an optional custom health check.final String
id()
The ID that Cloud Map assigned to the service when you created it.final Integer
The number of instances that are currently associated with the service.final String
name()
The name of the service.final String
The ID of the namespace that was used to create the service.static Class
<? extends Service.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ServiceType
type()
Describes the systems that can be used to discover the service instances.final String
Describes the systems that can be used to discover the service instances.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID that Cloud Map assigned to the service when you created it.
- Returns:
- The ID that Cloud Map assigned to the service when you created it.
-
arn
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
- Returns:
- The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
-
name
The name of the service.
- Returns:
- The name of the service.
-
namespaceId
The ID of the namespace that was used to create the service.
- Returns:
- The ID of the namespace that was used to create the service.
-
description
The description of the service.
- Returns:
- The description of the service.
-
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.
- Returns:
- 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.
-
dnsConfig
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.- Returns:
- A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create
when you register an instance.
The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.
-
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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 Also:
-
typeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
type
will returnServiceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- 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 Also:
-
healthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains 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
.For information about the charges for health checks, see Amazon Route 53 Pricing.
- Returns:
- Public DNS and HTTP namespaces only. A complex type that contains 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
.For information about the charges for health checks, see Amazon Route 53 Pricing.
-
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
orHealthCheckConfig
but not both.- Returns:
- A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.
-
createDate
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of
CreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The
value of
CreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
-
creatorRequestId
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
CreatorRequestId
can be any unique string (for example, a date/timestamp).- Returns:
- A unique string that identifies the request and that allows failed requests to be retried without the
risk of running the operation twice.
CreatorRequestId
can be any unique string (for example, a date/timestamp).
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Service.Builder,
Service> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-